/mandos/release : revision 237.7.305

1

#!/usr/bin/python3 -bI

2

# -*- coding: utf-8; lexical-binding: t -*-

3

#

1

#!/usr/bin/python2.7

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

33

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

37

from future_builtins import *

41

38

42

import sys

43

import unittest

44

import argparse

45

import logging

46

import os

47

39

try:

48

40

import SocketServer as socketserver

49

41

except ImportError:

50

42

import socketserver

51

43

import socket

44

import argparse

52

45

import datetime

53

46

import errno

47

import gnutls.crypto

48

import gnutls.connection

49

import gnutls.errors

50

import gnutls.library.functions

51

import gnutls.library.constants

52

import gnutls.library.types

54

53

try:

55

54

import ConfigParser as configparser

56

55

except ImportError:

57

56

import configparser

57

import sys

58

import re

59

import os

59

60

import signal

60

61

import subprocess

61

62

import atexit

62

63

import stat

64

import logging

63

65

import logging.handlers

64

66

import pwd

65

67

import contextlib

77

79

import itertools

78

80

import collections

79

81

import codecs

80

import random

81

import shlex

82

83

import dbus

84

import dbus.service

85

import gi

86

from gi.repository import GLib

85

try:

86

import gobject

87

except ImportError:

88

from gi.repository import GObject as gobject

89

import avahi

87

90

from dbus.mainloop.glib import DBusGMainLoop

88

91

import ctypes

89

92

import ctypes.util

90

93

import xml.dom.minidom

91

94

import inspect

92

95

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

input = raw_input

97

98

# Add collections.abc.Callable if it does not exist

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Show warnings by default

114

if not sys.warnoptions:

115

import warnings

116

warnings.simplefilter("default")

117

118

# Try to find the value of SO_BINDTODEVICE:

119

try:

120

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

121

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

96

try:

122

97

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

123

98

except AttributeError:

124

99

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

127

100

from IN import SO_BINDTODEVICE

128

101

except ImportError:

129

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

130

# Try running the C preprocessor:

131

try:

132

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

133

"/dev/stdin"],

134

stdin=subprocess.PIPE,

135

stdout=subprocess.PIPE)

136

stdout = cc.communicate(

137

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

138

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

139

except (OSError, ValueError, IndexError):

140

# No value found

141

SO_BINDTODEVICE = None

142

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

145

146

version = "1.8.16"

102

SO_BINDTODEVICE = None

103

104

if sys.version_info.major == 2:

105

str = unicode

106

107

version = "1.6.9"

147

108

stored_state_file = "clients.pickle"

148

109

149

log = logging.getLogger(os.path.basename(sys.argv[0]))

150

logging.captureWarnings(True) # Show warnings via the logging system

110

logger = logging.getLogger()

151

111

syslogger = None

152

112

153

113

try:

154

114

if_nametoindex = ctypes.cdll.LoadLibrary(

155

115

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

156

116

except (OSError, AttributeError):

157

117

158

118

def if_nametoindex(interface):

159

119

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

160

120

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

165

125

return interface_index

166

126

167

127

168

def copy_function(func):

169

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

170

if sys.version_info.major == 2:

171

return types.FunctionType(func.func_code,

172

func.func_globals,

173

func.func_name,

174

func.func_defaults,

175

func.func_closure)

176

else:

177

return types.FunctionType(func.__code__,

178

func.__globals__,

179

func.__name__,

180

func.__defaults__,

181

func.__closure__)

182

183

184

128

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

185

129

"""init logger and add loglevel"""

186

130

187

131

global syslogger

188

132

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

133

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

134

address = "/dev/log"))

191

135

syslogger.setFormatter(logging.Formatter

192

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

193

" %(message)s"))

194

log.addHandler(syslogger)

195

136

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

137

' %(message)s'))

138

logger.addHandler(syslogger)

139

196

140

if debug:

197

141

console = logging.StreamHandler()

198

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

199

" [%(process)d]:"

200

" %(levelname)s:"

201

" %(message)s"))

202

log.addHandler(console)

203

log.setLevel(level)

142

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

143

' [%(process)d]:'

144

' %(levelname)s:'

145

' %(message)s'))

146

logger.addHandler(console)

147

logger.setLevel(level)

204

148

205

149

206

150

class PGPError(Exception):

208

152

pass

209

153

210

154

211

class PGPEngine:

155

class PGPEngine(object):

212

156

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

213

157

214

158

def __init__(self):

215

159

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

216

self.gpg = "gpg"

217

try:

218

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

219

for line in output.splitlines():

220

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

221

if name == b"gpg":

222

self.gpg = path

223

break

224

except OSError as e:

225

if e.errno != errno.ENOENT:

226

raise

227

self.gnupgargs = ["--batch",

228

"--homedir", self.tempdir,

229

"--force-mdc",

230

"--quiet"]

231

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

232

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

233

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

234

160

self.gnupgargs = ['--batch',

161

'--home', self.tempdir,

162

'--force-mdc',

163

'--quiet',

164

'--no-use-agent']

165

235

166

def __enter__(self):

236

167

return self

237

168

238

169

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

239

170

self._cleanup()

240

171

return False

241

172

242

173

def __del__(self):

243

174

self._cleanup()

244

175

245

176

def _cleanup(self):

246

177

if self.tempdir is not None:

247

178

# Delete contents of tempdir

248

179

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

249

topdown=False):

180

topdown = False):

250

181

for filename in files:

251

182

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

252

183

for dirname in dirs:

254

185

# Remove tempdir

255

186

os.rmdir(self.tempdir)

256

187

self.tempdir = None

257

188

258

189

def password_encode(self, password):

259

190

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

260

191

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

265

196

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

266

197

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

267

198

return encoded

268

199

269

200

def encrypt(self, data, password):

270

201

passphrase = self.password_encode(password)

271

202

with tempfile.NamedTemporaryFile(

272

203

dir=self.tempdir) as passfile:

273

204

passfile.write(passphrase)

274

205

passfile.flush()

275

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

276

"--passphrase-file",

206

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

207

'--passphrase-file',

277

208

passfile.name]

278

209

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

210

stdin = subprocess.PIPE,

211

stdout = subprocess.PIPE,

212

stderr = subprocess.PIPE)

213

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

283

214

if proc.returncode != 0:

284

215

raise PGPError(err)

285

216

return ciphertext

286

217

287

218

def decrypt(self, data, password):

288

219

passphrase = self.password_encode(password)

289

220

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

221

dir = self.tempdir) as passfile:

291

222

passfile.write(passphrase)

292

223

passfile.flush()

293

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

294

"--passphrase-file",

224

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

225

'--passphrase-file',

295

226

passfile.name]

296

227

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

228

stdin = subprocess.PIPE,

229

stdout = subprocess.PIPE,

230

stderr = subprocess.PIPE)

231

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

301

232

if proc.returncode != 0:

302

233

raise PGPError(err)

303

234

return decrypted_plaintext

304

235

305

236

306

# Pretend that we have an Avahi module

307

class avahi:

308

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

309

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

310

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

311

PROTO_INET = 0 # avahi-common/address.h

312

PROTO_INET6 = 1 # avahi-common/address.h

313

DBUS_NAME = "org.freedesktop.Avahi"

314

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

315

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

316

DBUS_PATH_SERVER = "/"

317

318

@staticmethod

319

def string_array_to_txt_array(t):

320

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

321

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

322

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

323

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

324

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

325

SERVER_INVALID = 0 # avahi-common/defs.h

326

SERVER_REGISTERING = 1 # avahi-common/defs.h

327

SERVER_RUNNING = 2 # avahi-common/defs.h

328

SERVER_COLLISION = 3 # avahi-common/defs.h

329

SERVER_FAILURE = 4 # avahi-common/defs.h

330

331

332

237

class AvahiError(Exception):

333

238

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

334

239

self.value = value

344

249

pass

345

250

346

251

347

class AvahiService:

252

class AvahiService(object):

348

253

"""An Avahi (Zeroconf) service.

349

254

350

255

Attributes:

351

256

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

352

257

Used to optionally bind to the specified interface.

353

name: string; Example: "Mandos"

354

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

258

name: string; Example: 'Mandos'

259

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

355

260

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

356

261

port: integer; what port to announce

357

262

TXT: list of strings; TXT record for the service

364

269

server: D-Bus Server

365

270

bus: dbus.SystemBus()

366

271

"""

367

272

368

273

def __init__(self,

369

interface=avahi.IF_UNSPEC,

370

name=None,

371

servicetype=None,

372

port=None,

373

TXT=None,

374

domain="",

375

host="",

376

max_renames=32768,

377

protocol=avahi.PROTO_UNSPEC,

378

bus=None):

274

interface = avahi.IF_UNSPEC,

275

name = None,

276

servicetype = None,

277

port = None,

278

TXT = None,

279

domain = "",

280

host = "",

281

max_renames = 32768,

282

protocol = avahi.PROTO_UNSPEC,

283

bus = None):

379

284

self.interface = interface

380

285

self.name = name

381

286

self.type = servicetype

390

295

self.server = None

391

296

self.bus = bus

392

297

self.entry_group_state_changed_match = None

393

298

394

299

def rename(self, remove=True):

395

300

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

396

301

if self.rename_count >= self.max_renames:

397

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

398

" after %i retries, exiting.",

399

self.rename_count)

302

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

303

" after %i retries, exiting.",

304

self.rename_count)

400

305

raise AvahiServiceError("Too many renames")

401

306

self.name = str(

402

307

self.server.GetAlternativeServiceName(self.name))

403

308

self.rename_count += 1

404

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

405

self.name)

309

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

310

self.name)

406

311

if remove:

407

312

self.remove()

408

313

try:

410

315

except dbus.exceptions.DBusException as error:

411

316

if (error.get_dbus_name()

412

317

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

413

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

318

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

414

319

return self.rename(remove=False)

415

320

else:

416

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

321

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

417

322

self.cleanup()

418

323

os._exit(1)

419

324

420

325

def remove(self):

421

326

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

422

327

if self.entry_group_state_changed_match is not None:

424

329

self.entry_group_state_changed_match = None

425

330

if self.group is not None:

426

331

self.group.Reset()

427

332

428

333

def add(self):

429

334

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

430

335

self.remove()

435

340

avahi.DBUS_INTERFACE_ENTRY_GROUP)

436

341

self.entry_group_state_changed_match = (

437

342

self.group.connect_to_signal(

438

"StateChanged", self.entry_group_state_changed))

439

log.debug("Adding Zeroconf service '%s' of type '%s' ...",

440

self.name, self.type)

343

'StateChanged', self.entry_group_state_changed))

344

logger.debug("Adding Zeroconf service '%s' of type '%s' ...",

345

self.name, self.type)

441

346

self.group.AddService(

442

347

self.interface,

443

348

self.protocol,

447

352

dbus.UInt16(self.port),

448

353

avahi.string_array_to_txt_array(self.TXT))

449

354

self.group.Commit()

450

355

451

356

def entry_group_state_changed(self, state, error):

452

357

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

453

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

454

358

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

359

455

360

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

log.debug("Zeroconf service established.")

361

logger.debug("Zeroconf service established.")

457

362

elif state == avahi.ENTRY_GROUP_COLLISION:

458

log.info("Zeroconf service name collision.")

363

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

459

364

self.rename()

460

365

elif state == avahi.ENTRY_GROUP_FAILURE:

461

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

462

str(error))

366

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

367

str(error))

463

368

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

464

369

465

370

def cleanup(self):

466

371

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

467

372

if self.group is not None:

472

377

pass

473

378

self.group = None

474

379

self.remove()

475

380

476

381

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

477

382

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

478

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

383

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

479

384

bad_states = {

480

385

avahi.SERVER_INVALID: "Zeroconf server invalid",

481

386

avahi.SERVER_REGISTERING: None,

485

390

if state in bad_states:

486

391

if bad_states[state] is not None:

487

392

if error is None:

488

log.error(bad_states[state])

393

logger.error(bad_states[state])

489

394

else:

490

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

395

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

491

396

self.cleanup()

492

397

elif state == avahi.SERVER_RUNNING:

493

try:

494

self.add()

495

except dbus.exceptions.DBusException as error:

496

if (error.get_dbus_name()

497

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

498

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

499

return self.rename(remove=False)

500

else:

501

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

502

self.cleanup()

503

os._exit(1)

398

self.add()

504

399

else:

505

400

if error is None:

506

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

401

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

507

402

else:

508

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

509

403

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

404

510

405

def activate(self):

511

406

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

512

407

if self.server is None:

523

418

class AvahiServiceToSyslog(AvahiService):

524

419

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

525

420

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

526

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

527

**kwargs)

421

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

528

422

syslogger.setFormatter(logging.Formatter(

529

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

423

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

530

424

.format(self.name)))

531

425

return ret

532

426

533

534

# Pretend that we have a GnuTLS module

535

class gnutls:

536

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

537

538

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

539

if library is None:

540

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

541

_library = ctypes.cdll.LoadLibrary(library)

542

del library

543

544

# Unless otherwise indicated, the constants and types below are

545

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

546

547

# Constants

548

E_SUCCESS = 0

549

E_INTERRUPTED = -52

550

E_AGAIN = -28

551

CRT_OPENPGP = 2

552

CRT_RAWPK = 3

553

CLIENT = 2

554

SHUT_RDWR = 0

555

CRD_CERTIFICATE = 1

556

E_NO_CERTIFICATE_FOUND = -49

557

X509_FMT_DER = 0

558

NO_TICKETS = 1<<10

559

ENABLE_RAWPK = 1<<18

560

CTYPE_PEERS = 3

561

KEYID_USE_SHA256 = 1 # gnutls/x509.h

562

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

563

564

# Types

565

class _session_int(ctypes.Structure):

566

_fields_ = []

567

session_t = ctypes.POINTER(_session_int)

568

569

class certificate_credentials_st(ctypes.Structure):

570

_fields_ = []

571

certificate_credentials_t = ctypes.POINTER(

572

certificate_credentials_st)

573

certificate_type_t = ctypes.c_int

574

575

class datum_t(ctypes.Structure):

576

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

577

("size", ctypes.c_uint)]

578

579

class _openpgp_crt_int(ctypes.Structure):

580

_fields_ = []

581

openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)

582

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

583

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

584

credentials_type_t = ctypes.c_int

585

transport_ptr_t = ctypes.c_void_p

586

close_request_t = ctypes.c_int

587

588

# Exceptions

589

class Error(Exception):

590

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

591

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

592

# code is passed, convert it to a string with

593

# gnutls.strerror()

594

self.code = code

595

if message is None and code is not None:

596

message = gnutls.strerror(code).decode(

597

"utf-8", errors="replace")

598

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

599

message, *args)

600

601

class CertificateSecurityError(Error):

602

pass

603

604

class PointerTo:

605

def __init__(self, cls):

606

self.cls = cls

607

608

def from_param(self, obj):

609

if not isinstance(obj, self.cls):

610

raise TypeError("Not of type {}: {!r}"

611

.format(self.cls.__name__, obj))

612

return ctypes.byref(obj.from_param(obj))

613

614

class CastToVoidPointer:

615

def __init__(self, cls):

616

self.cls = cls

617

618

def from_param(self, obj):

619

if not isinstance(obj, self.cls):

620

raise TypeError("Not of type {}: {!r}"

621

.format(self.cls.__name__, obj))

622

return ctypes.cast(obj.from_param(obj), ctypes.c_void_p)

623

624

class With_from_param:

625

@classmethod

626

def from_param(cls, obj):

627

return obj._as_parameter_

628

629

# Classes

630

class Credentials(With_from_param):

631

def __init__(self):

632

self._as_parameter_ = gnutls.certificate_credentials_t()

633

gnutls.certificate_allocate_credentials(self)

634

self.type = gnutls.CRD_CERTIFICATE

635

636

def __del__(self):

637

gnutls.certificate_free_credentials(self)

638

639

class ClientSession(With_from_param):

640

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

641

self._as_parameter_ = gnutls.session_t()

642

gnutls_flags = gnutls.CLIENT

643

if gnutls.check_version(b"3.5.6"):

644

gnutls_flags |= gnutls.NO_TICKETS

645

if gnutls.has_rawpk:

646

gnutls_flags |= gnutls.ENABLE_RAWPK

647

gnutls.init(self, gnutls_flags)

648

del gnutls_flags

649

gnutls.set_default_priority(self)

650

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

651

gnutls.handshake_set_private_extensions(self, True)

652

self.socket = socket

653

if credentials is None:

654

credentials = gnutls.Credentials()

655

gnutls.credentials_set(self, credentials.type,

656

credentials)

657

self.credentials = credentials

658

659

def __del__(self):

660

gnutls.deinit(self)

661

662

def handshake(self):

663

return gnutls.handshake(self)

664

665

def send(self, data):

666

data = bytes(data)

667

data_len = len(data)

668

while data_len > 0:

669

data_len -= gnutls.record_send(self, data[-data_len:],

670

data_len)

671

672

def bye(self):

673

return gnutls.bye(self, gnutls.SHUT_RDWR)

674

675

# Error handling functions

676

def _error_code(result):

677

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

678

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

679

if result >= gnutls.E_SUCCESS:

680

return result

681

if result == gnutls.E_NO_CERTIFICATE_FOUND:

682

raise gnutls.CertificateSecurityError(code=result)

683

raise gnutls.Error(code=result)

684

685

def _retry_on_error(result, func, arguments,

686

_error_code=_error_code):

687

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

688

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

689

while result < gnutls.E_SUCCESS:

690

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

691

return _error_code(result)

692

result = func(*arguments)

693

return result

694

695

# Unless otherwise indicated, the function declarations below are

696

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

697

698

# Functions

699

priority_set_direct = _library.gnutls_priority_set_direct

700

priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,

701

ctypes.POINTER(ctypes.c_char_p)]

702

priority_set_direct.restype = _error_code

703

704

init = _library.gnutls_init

705

init.argtypes = [PointerTo(ClientSession), ctypes.c_int]

706

init.restype = _error_code

707

708

set_default_priority = _library.gnutls_set_default_priority

709

set_default_priority.argtypes = [ClientSession]

710

set_default_priority.restype = _error_code

711

712

record_send = _library.gnutls_record_send

713

record_send.argtypes = [ClientSession, ctypes.c_void_p,

714

ctypes.c_size_t]

715

record_send.restype = ctypes.c_ssize_t

716

record_send.errcheck = _retry_on_error

717

718

certificate_allocate_credentials = (

719

_library.gnutls_certificate_allocate_credentials)

720

certificate_allocate_credentials.argtypes = [

721

PointerTo(Credentials)]

722

certificate_allocate_credentials.restype = _error_code

723

724

certificate_free_credentials = (

725

_library.gnutls_certificate_free_credentials)

726

certificate_free_credentials.argtypes = [Credentials]

727

certificate_free_credentials.restype = None

728

729

handshake_set_private_extensions = (

730

_library.gnutls_handshake_set_private_extensions)

731

handshake_set_private_extensions.argtypes = [ClientSession,

732

ctypes.c_int]

733

handshake_set_private_extensions.restype = None

734

735

credentials_set = _library.gnutls_credentials_set

736

credentials_set.argtypes = [ClientSession, credentials_type_t,

737

CastToVoidPointer(Credentials)]

738

credentials_set.restype = _error_code

739

740

strerror = _library.gnutls_strerror

741

strerror.argtypes = [ctypes.c_int]

742

strerror.restype = ctypes.c_char_p

743

744

certificate_type_get = _library.gnutls_certificate_type_get

745

certificate_type_get.argtypes = [ClientSession]

746

certificate_type_get.restype = _error_code

747

748

certificate_get_peers = _library.gnutls_certificate_get_peers

749

certificate_get_peers.argtypes = [ClientSession,

750

ctypes.POINTER(ctypes.c_uint)]

751

certificate_get_peers.restype = ctypes.POINTER(datum_t)

752

753

global_set_log_level = _library.gnutls_global_set_log_level

754

global_set_log_level.argtypes = [ctypes.c_int]

755

global_set_log_level.restype = None

756

757

global_set_log_function = _library.gnutls_global_set_log_function

758

global_set_log_function.argtypes = [log_func]

759

global_set_log_function.restype = None

760

761

deinit = _library.gnutls_deinit

762

deinit.argtypes = [ClientSession]

763

deinit.restype = None

764

765

handshake = _library.gnutls_handshake

766

handshake.argtypes = [ClientSession]

767

handshake.restype = ctypes.c_int

768

handshake.errcheck = _retry_on_error

769

770

transport_set_ptr = _library.gnutls_transport_set_ptr

771

transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]

772

transport_set_ptr.restype = None

773

774

bye = _library.gnutls_bye

775

bye.argtypes = [ClientSession, close_request_t]

776

bye.restype = ctypes.c_int

777

bye.errcheck = _retry_on_error

778

779

check_version = _library.gnutls_check_version

780

check_version.argtypes = [ctypes.c_char_p]

781

check_version.restype = ctypes.c_char_p

782

783

_need_version = b"3.3.0"

784

if check_version(_need_version) is None:

785

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

786

.format(_need_version))

787

788

_tls_rawpk_version = b"3.6.6"

789

has_rawpk = bool(check_version(_tls_rawpk_version))

790

791

if has_rawpk:

792

# Types

793

class pubkey_st(ctypes.Structure):

794

_fields = []

795

pubkey_t = ctypes.POINTER(pubkey_st)

796

797

x509_crt_fmt_t = ctypes.c_int

798

799

# All the function declarations below are from

800

# gnutls/abstract.h

801

pubkey_init = _library.gnutls_pubkey_init

802

pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]

803

pubkey_init.restype = _error_code

804

805

pubkey_import = _library.gnutls_pubkey_import

806

pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),

807

x509_crt_fmt_t]

808

pubkey_import.restype = _error_code

809

810

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

811

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

812

ctypes.POINTER(ctypes.c_ubyte),

813

ctypes.POINTER(ctypes.c_size_t)]

814

pubkey_get_key_id.restype = _error_code

815

816

pubkey_deinit = _library.gnutls_pubkey_deinit

817

pubkey_deinit.argtypes = [pubkey_t]

818

pubkey_deinit.restype = None

819

else:

820

# All the function declarations below are from

821

# gnutls/openpgp.h

822

823

openpgp_crt_init = _library.gnutls_openpgp_crt_init

824

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

825

openpgp_crt_init.restype = _error_code

826

827

openpgp_crt_import = _library.gnutls_openpgp_crt_import

828

openpgp_crt_import.argtypes = [openpgp_crt_t,

829

ctypes.POINTER(datum_t),

830

openpgp_crt_fmt_t]

831

openpgp_crt_import.restype = _error_code

832

833

openpgp_crt_verify_self = \

834

_library.gnutls_openpgp_crt_verify_self

835

openpgp_crt_verify_self.argtypes = [

836

openpgp_crt_t,

837

ctypes.c_uint,

838

ctypes.POINTER(ctypes.c_uint),

839

]

840

openpgp_crt_verify_self.restype = _error_code

841

842

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

843

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

844

openpgp_crt_deinit.restype = None

845

846

openpgp_crt_get_fingerprint = (

847

_library.gnutls_openpgp_crt_get_fingerprint)

848

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

849

ctypes.c_void_p,

850

ctypes.POINTER(

851

ctypes.c_size_t)]

852

openpgp_crt_get_fingerprint.restype = _error_code

853

854

if check_version(b"3.6.4"):

855

certificate_type_get2 = _library.gnutls_certificate_type_get2

856

certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]

857

certificate_type_get2.restype = _error_code

858

859

# Remove non-public functions

860

del _error_code, _retry_on_error

861

862

863

427

def call_pipe(connection, # : multiprocessing.Connection

864

428

func, *args, **kwargs):

865

429

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

866

430

867

431

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

868

432

return value on the provided multiprocessing.Connection.

869

433

"""

870

434

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

871

435

connection.close()

872

436

873

874

class Client:

437

class Client(object):

875

438

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

876

439

877

440

Attributes:

878

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

441

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

879

442

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

880

443

approval_duration: datetime.timedelta(); Duration of one approval

881

checker: multiprocessing.Process(); a running checker process used

882

to see if the client lives. None if no process is

883

running.

884

checker_callback_tag: a GLib event source tag, or None

444

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

445

to see if the client lives.

446

'None' if no process is running.

447

checker_callback_tag: a gobject event source tag, or None

885

448

checker_command: string; External command which is run to check

886

449

if client lives. %() expansions are done at

887

450

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

888

451

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

889

checker_initiator_tag: a GLib event source tag, or None

452

checker_initiator_tag: a gobject event source tag, or None

890

453

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

891

454

client_structure: Object describing what attributes a client has

892

455

and is used for storing the client at exit

893

456

current_checker_command: string; current running checker_command

894

disable_initiator_tag: a GLib event source tag, or None

457

disable_initiator_tag: a gobject event source tag, or None

895

458

enabled: bool()

896

459

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

897

uniquely identify an OpenPGP client

898

key_id: string (64 hexadecimal digits); used to uniquely identify

899

a client using raw public keys

460

uniquely identify the client

900

461

host: string; available for use by the checker command

901

462

interval: datetime.timedelta(); How often to start a new checker

902

463

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

918

479

disabled, or None

919

480

server_settings: The server_settings dict from main()

920

481

"""

921

482

922

483

runtime_expansions = ("approval_delay", "approval_duration",

923

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

484

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

924

485

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

925

486

"last_approval_request", "last_checked_ok",

926

487

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

935

496

"approved_by_default": "True",

936

497

"enabled": "True",

937

498

}

938

499

939

500

@staticmethod

940

501

def config_parser(config):

941

502

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

948

509

for client_name in config.sections():

949

510

section = dict(config.items(client_name))

950

511

client = settings[client_name] = {}

951

512

952

513

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

953

514

# Reformat values from string types to Python types

954

515

client["approved_by_default"] = config.getboolean(

955

516

client_name, "approved_by_default")

956

517

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

957

518

"enabled")

958

959

# Uppercase and remove spaces from key_id and fingerprint

960

# for later comparison purposes with return value from the

961

# key_id() and fingerprint() functions

962

client["key_id"] = (section.get("key_id", "").upper()

963

.replace(" ", ""))

964

client["fingerprint"] = (section.get("fingerprint",

965

"").upper()

519

520

# Uppercase and remove spaces from fingerprint for later

521

# comparison purposes with return value from the

522

# fingerprint() function

523

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

966

524

.replace(" ", ""))

967

if not (client["key_id"] or client["fingerprint"]):

968

log.error("Skipping client %s without key_id or"

969

" fingerprint", client_name)

970

del settings[client_name]

971

continue

972

525

if "secret" in section:

973

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

974

.encode("utf-8"),

975

"base64")

526

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

976

527

elif "secfile" in section:

977

528

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

978

529

(section["secfile"])),

993

544

client["last_approval_request"] = None

994

545

client["last_checked_ok"] = None

995

546

client["last_checker_status"] = -2

996

547

997

548

return settings

998

999

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

549

550

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

1000

551

self.name = name

1001

552

if server_settings is None:

1002

553

server_settings = {}

1004

555

# adding all client settings

1005

556

for setting, value in settings.items():

1006

557

setattr(self, setting, value)

1007

558

1008

559

if self.enabled:

1009

560

if not hasattr(self, "last_enabled"):

1010

561

self.last_enabled = datetime.datetime.utcnow()

1014

565

else:

1015

566

self.last_enabled = None

1016

567

self.expires = None

1017

1018

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

1019

log.debug(" Key ID: %s", self.key_id)

1020

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

568

569

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

570

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

1021

571

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

1022

572

datetime.datetime.utcnow())

1023

573

1024

574

# attributes specific for this server instance

1025

575

self.checker = None

1026

576

self.checker_initiator_tag = None

1032

582

self.changedstate = multiprocessing_manager.Condition(

1033

583

multiprocessing_manager.Lock())

1034

584

self.client_structure = [attr

1035

for attr in self.__dict__.keys()

585

for attr in self.__dict__.iterkeys()

1036

586

if not attr.startswith("_")]

1037

587

self.client_structure.append("client_structure")

1038

588

1039

589

for name, t in inspect.getmembers(

1040

590

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

1041

591

if not name.startswith("_"):

1042

592

self.client_structure.append(name)

1043

593

1044

594

# Send notice to process children that client state has changed

1045

595

def send_changedstate(self):

1046

596

with self.changedstate:

1047

597

self.changedstate.notify_all()

1048

598

1049

599

def enable(self):

1050

600

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

1051

601

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

1052

602

# Already enabled

1053

603

return

604

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

1054

605

self.enabled = True

1055

606

self.last_enabled = datetime.datetime.utcnow()

1056

607

self.init_checker()

1057

608

self.send_changedstate()

1058

609

1059

610

def disable(self, quiet=True):

1060

611

"""Disable this client."""

1061

612

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

1062

613

return False

1063

614

if not quiet:

1064

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

615

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

1065

616

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

1066

GLib.source_remove(self.disable_initiator_tag)

617

gobject.source_remove(self.disable_initiator_tag)

1067

618

self.disable_initiator_tag = None

1068

619

self.expires = None

1069

620

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

1070

GLib.source_remove(self.checker_initiator_tag)

621

gobject.source_remove(self.checker_initiator_tag)

1071

622

self.checker_initiator_tag = None

1072

623

self.stop_checker()

1073

624

self.enabled = False

1074

625

if not quiet:

1075

626

self.send_changedstate()

1076

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

627

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

1077

628

return False

1078

629

1079

630

def __del__(self):

1080

631

self.disable()

1081

1082

def init_checker(self, randomize_start=False):

1083

# Schedule a new checker to be started a randomly selected

1084

# time (a fraction of 'interval') from now. This spreads out

1085

# the startup of checkers over time when the server is

1086

# started.

632

633

def init_checker(self):

634

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

635

# and every interval from then on.

1087

636

if self.checker_initiator_tag is not None:

1088

GLib.source_remove(self.checker_initiator_tag)

1089

interval_milliseconds = int(self.interval.total_seconds()

1090

* 1000)

1091

if randomize_start:

1092

delay_milliseconds = random.randrange(

1093

interval_milliseconds + 1)

1094

else:

1095

delay_milliseconds = interval_milliseconds

1096

self.checker_initiator_tag = GLib.timeout_add(

1097

delay_milliseconds, self.start_checker, randomize_start)

1098

delay = datetime.timedelta(0, 0, 0, delay_milliseconds)

1099

# A checker might take up to an 'interval' of time, so we can

1100

# expire at the soonest one interval after a checker was

1101

# started. Since the initial checker is delayed, the expire

1102

# time might have to be extended.

1103

now = datetime.datetime.utcnow()

1104

self.expires = now + delay + self.interval

1105

# Schedule a disable() at expire time

637

gobject.source_remove(self.checker_initiator_tag)

638

self.checker_initiator_tag = gobject.timeout_add(

639

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

640

self.start_checker)

641

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

1106

642

if self.disable_initiator_tag is not None:

1107

GLib.source_remove(self.disable_initiator_tag)

1108

self.disable_initiator_tag = GLib.timeout_add(

1109

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

1110

self.disable)

1111

643

gobject.source_remove(self.disable_initiator_tag)

644

self.disable_initiator_tag = gobject.timeout_add(

645

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

646

# Also start a new checker *right now*.

647

self.start_checker()

648

1112

649

def checker_callback(self, source, condition, connection,

1113

650

command):

1114

651

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

652

self.checker_callback_tag = None

653

self.checker = None

1115

654

# Read return code from connection (see call_pipe)

1116

655

returncode = connection.recv()

1117

656

connection.close()

1118

if self.checker is not None:

1119

self.checker.join()

1120

self.checker_callback_tag = None

1121

self.checker = None

1122

657

1123

658

if returncode >= 0:

1124

659

self.last_checker_status = returncode

1125

660

self.last_checker_signal = None

1126

661

if self.last_checker_status == 0:

1127

log.info("Checker for %(name)s succeeded", vars(self))

662

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

663

vars(self))

1128

664

self.checked_ok()

1129

665

else:

1130

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

666

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

1131

667

else:

1132

668

self.last_checker_status = -1

1133

669

self.last_checker_signal = -returncode

1134

log.warning("Checker for %(name)s crashed?", vars(self))

670

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

671

vars(self))

1135

672

return False

1136

673

1137

674

def checked_ok(self):

1138

675

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

1139

676

self.last_checked_ok = datetime.datetime.utcnow()

1140

677

self.last_checker_status = 0

1141

678

self.last_checker_signal = None

1142

679

self.bump_timeout()

1143

680

1144

681

def bump_timeout(self, timeout=None):

1145

682

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

1146

683

if timeout is None:

1147

684

timeout = self.timeout

1148

685

if self.disable_initiator_tag is not None:

1149

GLib.source_remove(self.disable_initiator_tag)

686

gobject.source_remove(self.disable_initiator_tag)

1150

687

self.disable_initiator_tag = None

1151

688

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

1152

self.disable_initiator_tag = GLib.timeout_add(

689

self.disable_initiator_tag = gobject.timeout_add(

1153

690

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

1154

691

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

1155

692

1156

693

def need_approval(self):

1157

694

self.last_approval_request = datetime.datetime.utcnow()

1158

1159

def start_checker(self, start_was_randomized=False):

695

696

def start_checker(self):

1160

697

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

1161

698

1162

699

If a checker already exists, leave it running and do

1163

700

nothing."""

1164

701

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

1169

706

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

1170

707

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

1171

708

# should be.

1172

709

1173

710

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

1174

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

711

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

1175

712

self.checker.join()

1176

713

self.checker = None

1177

714

# Start a new checker if needed

1178

715

if self.checker is None:

1179

716

# Escape attributes for the shell

1180

717

escaped_attrs = {

1181

attr: shlex.quote(str(getattr(self, attr)))

1182

for attr in self.runtime_expansions}

718

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

719

for attr in self.runtime_expansions }

1183

720

try:

1184

721

command = self.checker_command % escaped_attrs

1185

722

except TypeError as error:

1186

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

1187

self.checker_command, exc_info=error)

723

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

724

self.checker_command,

725

exc_info=error)

1188

726

return True # Try again later

1189

727

self.current_checker_command = command

1190

log.info("Starting checker %r for %s", command, self.name)

728

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

729

self.name)

1191

730

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

1192

731

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

1193

732

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

1195

734

# The exception is when not debugging but nevertheless

1196

735

# running in the foreground; use the previously

1197

736

# created wnull.

1198

popen_args = {"close_fds": True,

1199

"shell": True,

1200

"cwd": "/"}

737

popen_args = { "close_fds": True,

738

"shell": True,

739

"cwd": "/" }

1201

740

if (not self.server_settings["debug"]

1202

741

and self.server_settings["foreground"]):

1203

742

popen_args.update({"stdout": wnull,

1204

"stderr": wnull})

1205

pipe = multiprocessing.Pipe(duplex=False)

743

"stderr": wnull })

744

pipe = multiprocessing.Pipe(duplex = False)

1206

745

self.checker = multiprocessing.Process(

1207

target=call_pipe,

1208

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

1209

kwargs=popen_args)

746

target = call_pipe,

747

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

748

kwargs = popen_args)

1210

749

self.checker.start()

1211

self.checker_callback_tag = GLib.io_add_watch(

1212

GLib.IOChannel.unix_new(pipe[0].fileno()),

1213

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

750

self.checker_callback_tag = gobject.io_add_watch(

751

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

1214

752

self.checker_callback, pipe[0], command)

1215

if start_was_randomized:

1216

# We were started after a random delay; Schedule a new

1217

# checker to be started an 'interval' from now, and every

1218

# interval from then on.

1219

now = datetime.datetime.utcnow()

1220

self.checker_initiator_tag = GLib.timeout_add(

1221

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

1222

self.start_checker)

1223

self.expires = max(self.expires, now + self.interval)

1224

# Don't start a new checker again after same random delay

1225

return False

1226

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

753

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

1227

754

return True

1228

755

1229

756

def stop_checker(self):

1230

757

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

1231

758

if self.checker_callback_tag:

1232

GLib.source_remove(self.checker_callback_tag)

759

gobject.source_remove(self.checker_callback_tag)

1233

760

self.checker_callback_tag = None

1234

761

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

1235

762

return

1236

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

763

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

1237

764

self.checker.terminate()

1238

765

self.checker = None

1239

766

1244

771

byte_arrays=False):

1245

772

"""Decorators for marking methods of a DBusObjectWithProperties to

1246

773

become properties on the D-Bus.

1247

774

1248

775

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

1249

776

and with one argument by "Set".

1250

777

1251

778

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

1252

779

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

1253

780

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

1257

784

if byte_arrays and signature != "ay":

1258

785

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

1259

786

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

1260

787

1261

788

def decorator(func):

1262

789

func._dbus_is_property = True

1263

790

func._dbus_interface = dbus_interface

1266

793

func._dbus_name = func.__name__

1267

794

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

1268

795

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

1269

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

796

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1270

797

return func

1271

798

1272

799

return decorator

1273

800

1274

801

1275

802

def dbus_interface_annotations(dbus_interface):

1276

803

"""Decorator for marking functions returning interface annotations

1277

804

1278

805

Usage:

1279

806

1280

807

@dbus_interface_annotations("org.example.Interface")

1281

808

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

1282

809

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

1283

810

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

1284

811

"false"}

1285

812

"""

1286

813

1287

814

def decorator(func):

1288

815

func._dbus_is_interface = True

1289

816

func._dbus_interface = dbus_interface

1290

817

func._dbus_name = dbus_interface

1291

818

return func

1292

819

1293

820

return decorator

1294

821

1295

822

1296

823

def dbus_annotations(annotations):

1297

824

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

1298

825

Usage:

1299

826

1300

827

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

1301

828

"org.freedesktop.DBus.Property."

1302

829

"EmitsChangedSignal": "false"})

1304

831

access="r")

1305

832

def Property_dbus_property(self):

1306

833

return dbus.Boolean(False)

1307

1308

See also the DBusObjectWithAnnotations class.

1309

834

"""

1310

835

1311

836

def decorator(func):

1312

837

func._dbus_annotations = annotations

1313

838

return func

1314

839

1315

840

return decorator

1316

841

1317

842

1333

858

pass

1334

859

1335

860

1336

class DBusObjectWithAnnotations(dbus.service.Object):

1337

"""A D-Bus object with annotations.

1338

1339

Classes inheriting from this can use the dbus_annotations

1340

decorator to add annotations to methods or signals.

861

class DBusObjectWithProperties(dbus.service.Object):

862

"""A D-Bus object with properties.

863

864

Classes inheriting from this can use the dbus_service_property

865

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

866

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

1341

867

"""

1342

868

1343

869

@staticmethod

1344

870

def _is_dbus_thing(thing):

1345

871

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

1346

872

1347

873

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

1348

874

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

1349

875

"""

1350

876

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

1351

877

False)

1352

878

1353

879

def _get_all_dbus_things(self, thing):

1354

880

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

1355

881

"""

1358

884

for cls in self.__class__.__mro__

1359

885

for name, athing in

1360

886

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

1361

1362

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1363

out_signature="s",

1364

path_keyword="object_path",

1365

connection_keyword="connection")

1366

def Introspect(self, object_path, connection):

1367

"""Overloading of standard D-Bus method.

1368

1369

Inserts annotation tags on methods and signals.

1370

"""

1371

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

1372

connection)

1373

try:

1374

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

1375

1376

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

1377

# Add annotation tags

1378

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

1379

for tag in if_tag.getElementsByTagName(typ):

1380

annots = dict()

1381

for name, prop in (self.

1382

_get_all_dbus_things(typ)):

1383

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

1384

and prop._dbus_interface

1385

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

1386

annots.update(getattr(

1387

prop, "_dbus_annotations", {}))

1388

for name, value in annots.items():

1389

ann_tag = document.createElement(

1390

"annotation")

1391

ann_tag.setAttribute("name", name)

1392

ann_tag.setAttribute("value", value)

1393

tag.appendChild(ann_tag)

1394

# Add interface annotation tags

1395

for annotation, value in dict(

1396

itertools.chain.from_iterable(

1397

annotations().items()

1398

for name, annotations

1399

in self._get_all_dbus_things("interface")

1400

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

1401

)).items():

1402

ann_tag = document.createElement("annotation")

1403

ann_tag.setAttribute("name", annotation)

1404

ann_tag.setAttribute("value", value)

1405

if_tag.appendChild(ann_tag)

1406

# Fix argument name for the Introspect method itself

1407

if (if_tag.getAttribute("name")

1408

== dbus.INTROSPECTABLE_IFACE):

1409

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

1410

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

1411

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

1412

if (arg.getAttribute("direction")

1413

== "out"):

1414

arg.setAttribute("name",

1415

"xml_data")

1416

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

1417

document.unlink()

1418

except (AttributeError, xml.dom.DOMException,

1419

xml.parsers.expat.ExpatError) as error:

1420

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

1421

exc_info=error)

1422

return xmlstring

1423

1424

1425

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1426

"""A D-Bus object with properties.

1427

1428

Classes inheriting from this can use the dbus_service_property

1429

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

1430

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

1431

"""

1432

887

1433

888

def _get_dbus_property(self, interface_name, property_name):

1434

889

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

1435

890

property with the specified name and interface.

1440

895

if (value._dbus_name == property_name

1441

896

and value._dbus_interface == interface_name):

1442

897

return value.__get__(self)

1443

898

1444

899

# No such property

1445

900

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

1446

901

self.dbus_object_path, interface_name, property_name))

1447

1448

@classmethod

1449

def _get_all_interface_names(cls):

1450

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

1451

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

1452

"_dbus_interface", None)

1453

for x in (inspect.getmro(cls))

1454

for attr in dir(x))

1455

if name is not None)

1456

902

1457

903

@dbus.service.method(dbus.PROPERTIES_IFACE,

1458

904

in_signature="ss",

1459

905

out_signature="v")

1467

913

if not hasattr(value, "variant_level"):

1468

914

return value

1469

915

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

1470

916

1471

917

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

1472

918

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

1473

919

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

1482

928

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

1483

929

"'ay' signature {!r}"

1484

930

.format(prop._dbus_signature))

1485

value = dbus.ByteArray(bytes(value))

931

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

932

for byte in value))

1486

933

prop(value)

1487

934

1488

935

@dbus.service.method(dbus.PROPERTIES_IFACE,

1489

936

in_signature="s",

1490

937

out_signature="a{sv}")

1491

938

def GetAll(self, interface_name):

1492

939

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

1493

940

standard.

1494

941

1495

942

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

1496

943

"""

1497

944

properties = {}

1508

955

properties[name] = value

1509

956

continue

1510

957

properties[name] = type(value)(

1511

value, variant_level=value.variant_level + 1)

958

value, variant_level = value.variant_level + 1)

1512

959

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

1513

960

1514

961

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

1515

962

def PropertiesChanged(self, interface_name, changed_properties,

1516

963

invalidated_properties):

1518

965

standard.

1519

966

"""

1520

967

pass

1521

968

1522

969

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1523

970

out_signature="s",

1524

path_keyword="object_path",

1525

connection_keyword="connection")

971

path_keyword='object_path',

972

connection_keyword='connection')

1526

973

def Introspect(self, object_path, connection):

1527

974

"""Overloading of standard D-Bus method.

1528

975

1529

976

Inserts property tags and interface annotation tags.

1530

977

"""

1531

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1532

object_path,

1533

connection)

978

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

979

connection)

1534

980

try:

1535

981

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

1536

982

1537

983

def make_tag(document, name, prop):

1538

984

e = document.createElement("property")

1539

985

e.setAttribute("name", name)

1540

986

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

1541

987

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

1542

988

return e

1543

989

1544

990

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

1545

991

# Add property tags

1546

992

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

1549

995

if prop._dbus_interface

1550

996

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

1551

997

if_tag.appendChild(tag)

1552

# Add annotation tags for properties

1553

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

1554

annots = dict()

1555

for name, prop in self._get_all_dbus_things(

1556

"property"):

1557

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

1558

and prop._dbus_interface

1559

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

1560

annots.update(getattr(

1561

prop, "_dbus_annotations", {}))

1562

for name, value in annots.items():

1563

ann_tag = document.createElement(

1564

"annotation")

1565

ann_tag.setAttribute("name", name)

1566

ann_tag.setAttribute("value", value)

1567

tag.appendChild(ann_tag)

998

# Add annotation tags

999

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

1000

for tag in if_tag.getElementsByTagName(typ):

1001

annots = dict()

1002

for name, prop in (self.

1003

_get_all_dbus_things(typ)):

1004

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

1005

and prop._dbus_interface

1006

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

1007

annots.update(getattr(

1008

prop, "_dbus_annotations", {}))

1009

for name, value in annots.items():

1010

ann_tag = document.createElement(

1011

"annotation")

1012

ann_tag.setAttribute("name", name)

1013

ann_tag.setAttribute("value", value)

1014

tag.appendChild(ann_tag)

1015

# Add interface annotation tags

1016

for annotation, value in dict(

1017

itertools.chain.from_iterable(

1018

annotations().items()

1019

for name, annotations

1020

in self._get_all_dbus_things("interface")

1021

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

1022

)).items():

1023

ann_tag = document.createElement("annotation")

1024

ann_tag.setAttribute("name", annotation)

1025

ann_tag.setAttribute("value", value)

1026

if_tag.appendChild(ann_tag)

1568

1027

# Add the names to the return values for the

1569

1028

# "org.freedesktop.DBus.Properties" methods

1570

1029

if (if_tag.getAttribute("name")

1584

1043

document.unlink()

1585

1044

except (AttributeError, xml.dom.DOMException,

1586

1045

xml.parsers.expat.ExpatError) as error:

1587

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

1588

exc_info=error)

1589

return xmlstring

1590

1591

1592

try:

1593

dbus.OBJECT_MANAGER_IFACE

1594

except AttributeError:

1595

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

1596

1597

1598

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1599

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

1600

1601

Classes inheriting from this exposes the standard

1602

GetManagedObjects call and the InterfacesAdded and

1603

InterfacesRemoved signals on the standard

1604

"org.freedesktop.DBus.ObjectManager" interface.

1605

1606

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

1607

manually.

1608

"""

1609

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1610

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

1611

def GetManagedObjects(self):

1612

"""This function must be overridden"""

1613

raise NotImplementedError()

1614

1615

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1616

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

1617

def InterfacesAdded(self, object_path, interfaces_and_properties):

1618

pass

1619

1620

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

1621

def InterfacesRemoved(self, object_path, interfaces):

1622

pass

1623

1624

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1625

out_signature="s",

1626

path_keyword="object_path",

1627

connection_keyword="connection")

1628

def Introspect(self, object_path, connection):

1629

"""Overloading of standard D-Bus method.

1630

1631

Override return argument name of GetManagedObjects to be

1632

"objpath_interfaces_and_properties"

1633

"""

1634

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1635

object_path,

1636

connection)

1637

try:

1638

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

1639

1640

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

1641

# Fix argument name for the GetManagedObjects method

1642

if (if_tag.getAttribute("name")

1643

== dbus.OBJECT_MANAGER_IFACE):

1644

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

1645

if (cn.getAttribute("name")

1646

== "GetManagedObjects"):

1647

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

1648

if (arg.getAttribute("direction")

1649

== "out"):

1650

arg.setAttribute(

1651

"name",

1652

"objpath_interfaces"

1653

"_and_properties")

1654

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

1655

document.unlink()

1656

except (AttributeError, xml.dom.DOMException,

1657

xml.parsers.expat.ExpatError) as error:

1658

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

1659

exc_info=error)

1046

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

1047

exc_info=error)

1660

1048

return xmlstring

1661

1049

1662

1050

1663

1051

def datetime_to_dbus(dt, variant_level=0):

1664

1052

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

1665

1053

if dt is None:

1666

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

1054

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

1667

1055

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

1668

1056

1669

1057

1672

1060

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

1673

1061

interface names according to the "alt_interface_names" mapping.

1674

1062

Usage:

1675

1063

1676

1064

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

1677

1065

"net.example.AlternateInterface"})

1678

1066

class SampleDBusObject(dbus.service.Object):

1679

1067

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

1680

1068

def SampleDBusMethod():

1681

1069

pass

1682

1070

1683

1071

The above "SampleDBusMethod" on "SampleDBusObject" will be

1684

1072

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

1685

1073

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

1686

1074

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

1687

1075

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

1688

1076

1689

1077

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

1690

1078

(from DBusObjectWithProperties) and interfaces (from the

1691

1079

dbus_interface_annotations decorator).

1692

1080

"""

1693

1081

1694

1082

def wrapper(cls):

1695

1083

for orig_interface_name, alt_interface_name in (

1696

1084

alt_interface_names.items()):

1711

1099

interface_names.add(alt_interface)

1712

1100

# Is this a D-Bus signal?

1713

1101

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

1714

# Extract the original non-method undecorated

1715

# function by black magic

1716

1102

if sys.version_info.major == 2:

1103

# Extract the original non-method undecorated

1104

# function by black magic

1717

1105

nonmethod_func = (dict(

1718

1106

zip(attribute.func_code.co_freevars,

1719

1107

attribute.__closure__))

1720

1108

["func"].cell_contents)

1721

1109

else:

1722

nonmethod_func = (dict(

1723

zip(attribute.__code__.co_freevars,

1724

attribute.__closure__))

1725

["func"].cell_contents)

1110

nonmethod_func = attribute

1726

1111

# Create a new, but exactly alike, function

1727

1112

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

1728

1113

# with the alternate D-Bus interface name

1729

new_function = copy_function(nonmethod_func)

1114

if sys.version_info.major == 2:

1115

new_function = types.FunctionType(

1116

nonmethod_func.func_code,

1117

nonmethod_func.func_globals,

1118

nonmethod_func.func_name,

1119

nonmethod_func.func_defaults,

1120

nonmethod_func.func_closure)

1121

else:

1122

new_function = types.FunctionType(

1123

nonmethod_func.__code__,

1124

nonmethod_func.__globals__,

1125

nonmethod_func.__name__,

1126

nonmethod_func.__defaults__,

1127

nonmethod_func.__closure__)

1730

1128

new_function = (dbus.service.signal(

1731

1129

alt_interface,

1732

1130

attribute._dbus_signature)(new_function))

1736

1134

attribute._dbus_annotations)

1737

1135

except AttributeError:

1738

1136

pass

1739

1740

1137

# Define a creator of a function to call both the

1741

1138

# original and alternate functions, so both the

1742

1139

# original and alternate signals gets sent when

1745

1142

"""This function is a scope container to pass

1746

1143

func1 and func2 to the "call_both" function

1747

1144

outside of its arguments"""

1748

1749

@functools.wraps(func2)

1145

1750

1146

def call_both(*args, **kwargs):

1751

1147

"""This function will emit two D-Bus

1752

1148

signals by calling func1 and func2"""

1753

1149

func1(*args, **kwargs)

1754

1150

func2(*args, **kwargs)

1755

# Make wrapper function look like a D-Bus

1756

# signal

1757

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

1758

if name.startswith("_dbus_"):

1759

setattr(call_both, name, attr)

1760

1151

1761

1152

return call_both

1762

1153

# Create the "call_both" function and add it to

1763

1154

# the class

1773

1164

alt_interface,

1774

1165

attribute._dbus_in_signature,

1775

1166

attribute._dbus_out_signature)

1776

(copy_function(attribute)))

1167

(types.FunctionType(attribute.func_code,

1168

attribute.func_globals,

1169

attribute.func_name,

1170

attribute.func_defaults,

1171

attribute.func_closure)))

1777

1172

# Copy annotations, if any

1778

1173

try:

1779

1174

attr[attrname]._dbus_annotations = dict(

1791

1186

attribute._dbus_access,

1792

1187

attribute._dbus_get_args_options

1793

1188

["byte_arrays"])

1794

(copy_function(attribute)))

1189

(types.FunctionType(

1190

attribute.func_code,

1191

attribute.func_globals,

1192

attribute.func_name,

1193

attribute.func_defaults,

1194

attribute.func_closure)))

1795

1195

# Copy annotations, if any

1796

1196

try:

1797

1197

attr[attrname]._dbus_annotations = dict(

1806

1206

# to the class.

1807

1207

attr[attrname] = (

1808

1208

dbus_interface_annotations(alt_interface)

1809

(copy_function(attribute)))

1209

(types.FunctionType(attribute.func_code,

1210

attribute.func_globals,

1211

attribute.func_name,

1212

attribute.func_defaults,

1213

attribute.func_closure)))

1810

1214

if deprecate:

1811

1215

# Deprecate all alternate interfaces

1812

iname = "_AlternateDBusNames_interface_annotation{}"

1216

iname="_AlternateDBusNames_interface_annotation{}"

1813

1217

for interface_name in interface_names:

1814

1218

1815

1219

@dbus_interface_annotations(interface_name)

1816

1220

def func(self):

1817

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

1818

"true"}

1221

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

1222

"true" }

1819

1223

# Find an unused name

1820

1224

for aname in (iname.format(i)

1821

1225

for i in itertools.count()):

1825

1229

if interface_names:

1826

1230

# Replace the class with a new subclass of it with

1827

1231

# methods, signals, etc. as created above.

1828

if sys.version_info.major == 2:

1829

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

1830

(cls, ), attr)

1831

else:

1832

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

1833

(cls, ), attr)

1232

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

1233

(cls, ), attr)

1834

1234

return cls

1835

1235

1836

1236

return wrapper

1837

1237

1838

1238

1840

1240

"se.bsnet.fukt.Mandos"})

1841

1241

class ClientDBus(Client, DBusObjectWithProperties):

1842

1242

"""A Client class using D-Bus

1843

1243

1844

1244

Attributes:

1845

1245

dbus_object_path: dbus.ObjectPath

1846

1246

bus: dbus.SystemBus()

1847

1247

"""

1848

1248

1849

1249

runtime_expansions = (Client.runtime_expansions

1850

1250

+ ("dbus_object_path", ))

1851

1251

1852

1252

_interface = "se.recompile.Mandos.Client"

1853

1253

1854

1254

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

1855

1856

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

1255

1256

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

1857

1257

self.bus = bus

1858

1258

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

1859

1259

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

1865

1265

"/clients/" + client_object_name)

1866

1266

DBusObjectWithProperties.__init__(self, self.bus,

1867

1267

self.dbus_object_path)

1868

1268

1869

1269

def notifychangeproperty(transform_func, dbus_name,

1870

1270

type_func=lambda x: x,

1871

1271

variant_level=1,

1873

1273

_interface=_interface):

1874

1274

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

1875

1275

its changes to DBus.

1876

1276

1877

1277

transform_fun: Function that takes a value and a variant_level

1878

1278

and transforms it to a D-Bus type.

1879

1279

dbus_name: D-Bus name of the variable

1882

1282

variant_level: D-Bus variant level. Default: 1

1883

1283

"""

1884

1284

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

1885

1285

1886

1286

def setter(self, value):

1887

1287

if hasattr(self, "dbus_object_path"):

1888

1288

if (not hasattr(self, attrname) or

1895

1295

else:

1896

1296

dbus_value = transform_func(

1897

1297

type_func(value),

1898

variant_level=variant_level)

1298

variant_level = variant_level)

1899

1299

self.PropertyChanged(dbus.String(dbus_name),

1900

1300

dbus_value)

1901

1301

self.PropertiesChanged(

1902

1302

_interface,

1903

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

1904

dbus_value}),

1303

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

1304

dbus_value }),

1905

1305

dbus.Array())

1906

1306

setattr(self, attrname, value)

1907

1307

1908

1308

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

1909

1309

1910

1310

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1911

1311

approvals_pending = notifychangeproperty(dbus.Boolean,

1912

1312

"ApprovalPending",

1913

type_func=bool)

1313

type_func = bool)

1914

1314

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

1915

1315

last_enabled = notifychangeproperty(datetime_to_dbus,

1916

1316

"LastEnabled")

1917

1317

checker = notifychangeproperty(

1918

1318

dbus.Boolean, "CheckerRunning",

1919

type_func=lambda checker: checker is not None)

1319

type_func = lambda checker: checker is not None)

1920

1320

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1921

1321

"LastCheckedOK")

1922

1322

last_checker_status = notifychangeproperty(dbus.Int16,

1927

1327

"ApprovedByDefault")

1928

1328

approval_delay = notifychangeproperty(

1929

1329

dbus.UInt64, "ApprovalDelay",

1930

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

1330

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

1931

1331

approval_duration = notifychangeproperty(

1932

1332

dbus.UInt64, "ApprovalDuration",

1933

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

1333

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

1934

1334

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

1935

1335

timeout = notifychangeproperty(

1936

1336

dbus.UInt64, "Timeout",

1937

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

1337

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

1938

1338

extended_timeout = notifychangeproperty(

1939

1339

dbus.UInt64, "ExtendedTimeout",

1940

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

1340

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

1941

1341

interval = notifychangeproperty(

1942

1342

dbus.UInt64, "Interval",

1943

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

1343

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

1944

1344

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

1945

1345

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

1946

1346

invalidate_only=True)

1947

1347

1948

1348

del notifychangeproperty

1949

1349

1950

1350

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

1951

1351

try:

1952

1352

self.remove_from_connection()

1955

1355

if hasattr(DBusObjectWithProperties, "__del__"):

1956

1356

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

1957

1357

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

1958

1358

1959

1359

def checker_callback(self, source, condition,

1960

1360

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

1961

1361

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

1965

1365

if exitstatus >= 0:

1966

1366

# Emit D-Bus signal

1967

1367

self.CheckerCompleted(dbus.Int16(exitstatus),

1968

# This is specific to GNU libC

1969

dbus.Int64(exitstatus << 8),

1368

dbus.Int64(0),

1970

1369

dbus.String(command))

1971

1370

else:

1972

1371

# Emit D-Bus signal

1973

1372

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

1974

1373

dbus.Int64(

1975

# This is specific to GNU libC

1976

(exitstatus << 8)

1977

| self.last_checker_signal),

1374

self.last_checker_signal),

1978

1375

dbus.String(command))

1979

1376

return ret

1980

1377

1981

1378

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

1982

1379

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

1983

1380

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

1987

1384

# Emit D-Bus signal

1988

1385

self.CheckerStarted(self.current_checker_command)

1989

1386

return r

1990

1387

1991

1388

def _reset_approved(self):

1992

1389

self.approved = None

1993

1390

return False

1994

1391

1995

1392

def approve(self, value=True):

1996

1393

self.approved = value

1997

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

1998

* 1000), self._reset_approved)

1394

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

1395

* 1000), self._reset_approved)

1999

1396

self.send_changedstate()

2000

2001

# D-Bus methods, signals & properties

2002

2003

# Interfaces

2004

2005

# Signals

2006

1397

1398

## D-Bus methods, signals & properties

1399

1400

## Interfaces

1401

1402

## Signals

1403

2007

1404

# CheckerCompleted - signal

2008

1405

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

2009

1406

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

2010

1407

"D-Bus signal"

2011

1408

pass

2012

1409

2013

1410

# CheckerStarted - signal

2014

1411

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

2015

1412

def CheckerStarted(self, command):

2016

1413

"D-Bus signal"

2017

1414

pass

2018

1415

2019

1416

# PropertyChanged - signal

2020

1417

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

2021

1418

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

2022

1419

def PropertyChanged(self, property, value):

2023

1420

"D-Bus signal"

2024

1421

pass

2025

1422

2026

1423

# GotSecret - signal

2027

1424

@dbus.service.signal(_interface)

2028

1425

def GotSecret(self):

2031

1428

server to mandos-client

2032

1429

"""

2033

1430

pass

2034

1431

2035

1432

# Rejected - signal

2036

1433

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

2037

1434

def Rejected(self, reason):

2038

1435

"D-Bus signal"

2039

1436

pass

2040

1437

2041

1438

# NeedApproval - signal

2042

1439

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

2043

1440

def NeedApproval(self, timeout, default):

2044

1441

"D-Bus signal"

2045

1442

return self.need_approval()

2046

2047

# Methods

2048

1443

1444

## Methods

1445

2049

1446

# Approve - method

2050

1447

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

2051

1448

def Approve(self, value):

2052

1449

self.approve(value)

2053

1450

2054

1451

# CheckedOK - method

2055

1452

@dbus.service.method(_interface)

2056

1453

def CheckedOK(self):

2057

1454

self.checked_ok()

2058

1455

2059

1456

# Enable - method

2060

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

2061

1457

@dbus.service.method(_interface)

2062

1458

def Enable(self):

2063

1459

"D-Bus method"

2064

1460

self.enable()

2065

1461

2066

1462

# StartChecker - method

2067

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

2068

1463

@dbus.service.method(_interface)

2069

1464

def StartChecker(self):

2070

1465

"D-Bus method"

2071

1466

self.start_checker()

2072

1467

2073

1468

# Disable - method

2074

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

2075

1469

@dbus.service.method(_interface)

2076

1470

def Disable(self):

2077

1471

"D-Bus method"

2078

1472

self.disable()

2079

1473

2080

1474

# StopChecker - method

2081

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

2082

1475

@dbus.service.method(_interface)

2083

1476

def StopChecker(self):

2084

1477

self.stop_checker()

2085

2086

# Properties

2087

1478

1479

## Properties

1480

2088

1481

# ApprovalPending - property

2089

1482

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

2090

1483

def ApprovalPending_dbus_property(self):

2091

1484

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

2092

1485

2093

1486

# ApprovedByDefault - property

2094

1487

@dbus_service_property(_interface,

2095

1488

signature="b",

2098

1491

if value is None: # get

2099

1492

return dbus.Boolean(self.approved_by_default)

2100

1493

self.approved_by_default = bool(value)

2101

1494

2102

1495

# ApprovalDelay - property

2103

1496

@dbus_service_property(_interface,

2104

1497

signature="t",

2108

1501

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

2109

1502

* 1000)

2110

1503

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

2111

1504

2112

1505

# ApprovalDuration - property

2113

1506

@dbus_service_property(_interface,

2114

1507

signature="t",

2118

1511

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

2119

1512

* 1000)

2120

1513

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

2121

1514

2122

1515

# Name - property

2123

@dbus_annotations(

2124

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

2125

1516

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

2126

1517

def Name_dbus_property(self):

2127

1518

return dbus.String(self.name)

2128

2129

# KeyID - property

2130

@dbus_annotations(

2131

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

2132

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

2133

def KeyID_dbus_property(self):

2134

return dbus.String(self.key_id)

2135

1519

2136

1520

# Fingerprint - property

2137

@dbus_annotations(

2138

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

2139

1521

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

2140

1522

def Fingerprint_dbus_property(self):

2141

1523

return dbus.String(self.fingerprint)

2142

1524

2143

1525

# Host - property

2144

1526

@dbus_service_property(_interface,

2145

1527

signature="s",

2148

1530

if value is None: # get

2149

1531

return dbus.String(self.host)

2150

1532

self.host = str(value)

2151

1533

2152

1534

# Created - property

2153

@dbus_annotations(

2154

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

2155

1535

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

2156

1536

def Created_dbus_property(self):

2157

1537

return datetime_to_dbus(self.created)

2158

1538

2159

1539

# LastEnabled - property

2160

1540

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

2161

1541

def LastEnabled_dbus_property(self):

2162

1542

return datetime_to_dbus(self.last_enabled)

2163

1543

2164

1544

# Enabled - property

2165

1545

@dbus_service_property(_interface,

2166

1546

signature="b",

2172

1552

self.enable()

2173

1553

else:

2174

1554

self.disable()

2175

1555

2176

1556

# LastCheckedOK - property

2177

1557

@dbus_service_property(_interface,

2178

1558

signature="s",

2182

1562

self.checked_ok()

2183

1563

return

2184

1564

return datetime_to_dbus(self.last_checked_ok)

2185

1565

2186

1566

# LastCheckerStatus - property

2187

1567

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

2188

1568

def LastCheckerStatus_dbus_property(self):

2189

1569

return dbus.Int16(self.last_checker_status)

2190

1570

2191

1571

# Expires - property

2192

1572

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

2193

1573

def Expires_dbus_property(self):

2194

1574

return datetime_to_dbus(self.expires)

2195

1575

2196

1576

# LastApprovalRequest - property

2197

1577

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

2198

1578

def LastApprovalRequest_dbus_property(self):

2199

1579

return datetime_to_dbus(self.last_approval_request)

2200

1580

2201

1581

# Timeout - property

2202

1582

@dbus_service_property(_interface,

2203

1583

signature="t",

2218

1598

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

2219

1599

is None):

2220

1600

return

2221

GLib.source_remove(self.disable_initiator_tag)

2222

self.disable_initiator_tag = GLib.timeout_add(

1601

gobject.source_remove(self.disable_initiator_tag)

1602

self.disable_initiator_tag = gobject.timeout_add(

2223

1603

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

2224

1604

self.disable)

2225

1605

2226

1606

# ExtendedTimeout - property

2227

1607

@dbus_service_property(_interface,

2228

1608

signature="t",

2232

1612

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

2233

1613

* 1000)

2234

1614

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

2235

1615

2236

1616

# Interval - property

2237

1617

@dbus_service_property(_interface,

2238

1618

signature="t",

2245

1625

return

2246

1626

if self.enabled:

2247

1627

# Reschedule checker run

2248

GLib.source_remove(self.checker_initiator_tag)

2249

self.checker_initiator_tag = GLib.timeout_add(

1628

gobject.source_remove(self.checker_initiator_tag)

1629

self.checker_initiator_tag = gobject.timeout_add(

2250

1630

value, self.start_checker)

2251

self.start_checker() # Start one now, too

2252

1631

self.start_checker() # Start one now, too

1632

2253

1633

# Checker - property

2254

1634

@dbus_service_property(_interface,

2255

1635

signature="s",

2258

1638

if value is None: # get

2259

1639

return dbus.String(self.checker_command)

2260

1640

self.checker_command = str(value)

2261

1641

2262

1642

# CheckerRunning - property

2263

1643

@dbus_service_property(_interface,

2264

1644

signature="b",

2270

1650

self.start_checker()

2271

1651

else:

2272

1652

self.stop_checker()

2273

1653

2274

1654

# ObjectPath - property

2275

@dbus_annotations(

2276

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

2277

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

2278

1655

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

2279

1656

def ObjectPath_dbus_property(self):

2280

return self.dbus_object_path # is already a dbus.ObjectPath

2281

1657

return self.dbus_object_path # is already a dbus.ObjectPath

1658

2282

1659

# Secret = property

2283

@dbus_annotations(

2284

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

2285

"invalidates"})

2286

1660

@dbus_service_property(_interface,

2287

1661

signature="ay",

2288

1662

access="write",

2289

1663

byte_arrays=True)

2290

1664

def Secret_dbus_property(self, value):

2291

1665

self.secret = bytes(value)

2292

1666

2293

1667

del _interface

2294

1668

2295

1669

2296

class ProxyClient:

2297

def __init__(self, child_pipe, key_id, fpr, address):

1670

class ProxyClient(object):

1671

def __init__(self, child_pipe, fpr, address):

2298

1672

self._pipe = child_pipe

2299

self._pipe.send(("init", key_id, fpr, address))

1673

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

2300

1674

if not self._pipe.recv():

2301

raise KeyError(key_id or fpr)

2302

1675

raise KeyError(fpr)

1676

2303

1677

def __getattribute__(self, name):

2304

if name == "_pipe":

1678

if name == '_pipe':

2305

1679

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

2306

self._pipe.send(("getattr", name))

1680

self._pipe.send(('getattr', name))

2307

1681

data = self._pipe.recv()

2308

if data[0] == "data":

1682

if data[0] == 'data':

2309

1683

return data[1]

2310

if data[0] == "function":

2311

1684

if data[0] == 'function':

1685

2312

1686

def func(*args, **kwargs):

2313

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

1687

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

2314

1688

return self._pipe.recv()[1]

2315

1689

2316

1690

return func

2317

1691

2318

1692

def __setattr__(self, name, value):

2319

if name == "_pipe":

1693

if name == '_pipe':

2320

1694

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

2321

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

1695

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

2322

1696

2323

1697

2324

1698

class ClientHandler(socketserver.BaseRequestHandler, object):

2325

1699

"""A class to handle client connections.

2326

1700

2327

1701

Instantiated once for each connection to handle it.

2328

1702

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

2329

1703

2330

1704

def handle(self):

2331

1705

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

2332

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

2333

str(self.client_address))

2334

log.debug("Pipe FD: %d", self.server.child_pipe.fileno())

2335

2336

session = gnutls.ClientSession(self.request)

2337

2338

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

2339

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

2340

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

2341

# "+DHE-DSS"))

1706

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

1707

str(self.client_address))

1708

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

1709

self.server.child_pipe.fileno())

1710

1711

session = gnutls.connection.ClientSession(

1712

self.request, gnutls.connection .X509Credentials())

1713

1714

# Note: gnutls.connection.X509Credentials is really a

1715

# generic GnuTLS certificate credentials object so long as

1716

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

1717

# here despite using OpenPGP certificates.

1718

1719

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

1720

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

1721

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

1722

# "+DHE-DSS"))

2342

1723

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

2343

1724

priority = self.server.gnutls_priority

2344

1725

if priority is None:

2345

1726

priority = "NORMAL"

2346

gnutls.priority_set_direct(session,

2347

priority.encode("utf-8"), None)

2348

1727

gnutls.library.functions.gnutls_priority_set_direct(

1728

session._c_object, priority, None)

1729

2349

1730

# Start communication using the Mandos protocol

2350

1731

# Get protocol number

2351

1732

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

2352

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

1733

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

2353

1734

try:

2354

1735

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

2355

1736

raise RuntimeError(line)

2356

1737

except (ValueError, IndexError, RuntimeError) as error:

2357

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

1738

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

2358

1739

return

2359

1740

2360

1741

# Start GnuTLS connection

2361

1742

try:

2362

1743

session.handshake()

2363

except gnutls.Error as error:

2364

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

1744

except gnutls.errors.GNUTLSError as error:

1745

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

2365

1746

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

2366

1747

# established. Just abandon the request.

2367

1748

return

2368

log.debug("Handshake succeeded")

2369

1749

logger.debug("Handshake succeeded")

1750

2370

1751

approval_required = False

2371

1752

try:

2372

if gnutls.has_rawpk:

2373

fpr = b""

2374

try:

2375

key_id = self.key_id(

2376

self.peer_certificate(session))

2377

except (TypeError, gnutls.Error) as error:

2378

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

2379

return

2380

log.debug("Key ID: %s",

2381

key_id.decode("utf-8",

2382

errors="replace"))

2383

2384

else:

2385

key_id = b""

2386

try:

2387

fpr = self.fingerprint(

2388

self.peer_certificate(session))

2389

except (TypeError, gnutls.Error) as error:

2390

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

2391

return

2392

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

2393

2394

try:

2395

client = ProxyClient(child_pipe, key_id, fpr,

1753

try:

1754

fpr = self.fingerprint(

1755

self.peer_certificate(session))

1756

except (TypeError,

1757

gnutls.errors.GNUTLSError) as error:

1758

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

1759

return

1760

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

1761

1762

try:

1763

client = ProxyClient(child_pipe, fpr,

2396

1764

self.client_address)

2397

1765

except KeyError:

2398

1766

return

2399

1767

2400

1768

if client.approval_delay:

2401

1769

delay = client.approval_delay

2402

1770

client.approvals_pending += 1

2403

1771

approval_required = True

2404

1772

2405

1773

while True:

2406

1774

if not client.enabled:

2407

log.info("Client %s is disabled", client.name)

1775

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

1776

client.name)

2408

1777

if self.server.use_dbus:

2409

1778

# Emit D-Bus signal

2410

1779

client.Rejected("Disabled")

2411

1780

return

2412

1781

2413

1782

if client.approved or not client.approval_delay:

2414

# We are approved or approval is disabled

1783

#We are approved or approval is disabled

2415

1784

break

2416

1785

elif client.approved is None:

2417

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

2418

client.name)

1786

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

1787

client.name)

2419

1788

if self.server.use_dbus:

2420

1789

# Emit D-Bus signal

2421

1790

client.NeedApproval(

2422

1791

client.approval_delay.total_seconds()

2423

1792

* 1000, client.approved_by_default)

2424

1793

else:

2425

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

2426

client.name)

1794

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

1795

client.name)

2427

1796

if self.server.use_dbus:

2428

1797

# Emit D-Bus signal

2429

1798

client.Rejected("Denied")

2430

1799

return

2431

2432

# wait until timeout or approved

1800

1801

#wait until timeout or approved

2433

1802

time = datetime.datetime.now()

2434

1803

client.changedstate.acquire()

2435

1804

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

2437

1806

time2 = datetime.datetime.now()

2438

1807

if (time2 - time) >= delay:

2439

1808

if not client.approved_by_default:

2440

log.warning("Client %s timed out while"

2441

" waiting for approval",

2442

client.name)

1809

logger.warning("Client %s timed out while"

1810

" waiting for approval",

1811

client.name)

2443

1812

if self.server.use_dbus:

2444

1813

# Emit D-Bus signal

2445

1814

client.Rejected("Approval timed out")

2448

1817

break

2449

1818

else:

2450

1819

delay -= time2 - time

2451

2452

try:

2453

session.send(client.secret)

2454

except gnutls.Error as error:

2455

log.warning("gnutls send failed", exc_info=error)

2456

return

2457

2458

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

1820

1821

sent_size = 0

1822

while sent_size < len(client.secret):

1823

try:

1824

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

1825

except gnutls.errors.GNUTLSError as error:

1826

logger.warning("gnutls send failed",

1827

exc_info=error)

1828

return

1829

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

1830

len(client.secret) - (sent_size

1831

+ sent))

1832

sent_size += sent

1833

1834

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

2459

1835

# bump the timeout using extended_timeout

2460

1836

client.bump_timeout(client.extended_timeout)

2461

1837

if self.server.use_dbus:

2462

1838

# Emit D-Bus signal

2463

1839

client.GotSecret()

2464

1840

2465

1841

finally:

2466

1842

if approval_required:

2467

1843

client.approvals_pending -= 1

2468

1844

try:

2469

1845

session.bye()

2470

except gnutls.Error as error:

2471

log.warning("GnuTLS bye failed", exc_info=error)

2472

1846

except gnutls.errors.GNUTLSError as error:

1847

logger.warning("GnuTLS bye failed",

1848

exc_info=error)

1849

2473

1850

@staticmethod

2474

1851

def peer_certificate(session):

2475

"Return the peer's certificate as a bytestring"

2476

try:

2477

cert_type = gnutls.certificate_type_get2(

2478

session, gnutls.CTYPE_PEERS)

2479

except AttributeError:

2480

cert_type = gnutls.certificate_type_get(session)

2481

if gnutls.has_rawpk:

2482

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2483

else:

2484

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2485

# If not a valid certificate type...

2486

if cert_type not in valid_cert_types:

2487

log.info("Cert type %r not in %r", cert_type,

2488

valid_cert_types)

2489

# ...return invalid data

2490

return b""

1852

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

1853

# If not an OpenPGP certificate...

1854

if (gnutls.library.functions.gnutls_certificate_type_get(

1855

session._c_object)

1856

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1857

# ...do the normal thing

1858

return session.peer_certificate

2491

1859

list_size = ctypes.c_uint(1)

2492

cert_list = (gnutls.certificate_get_peers

2493

(session, ctypes.byref(list_size)))

1860

cert_list = (gnutls.library.functions

1861

.gnutls_certificate_get_peers

1862

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

2494

1863

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

2495

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

1864

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

1865

" certificate")

2496

1866

if list_size.value == 0:

2497

1867

return None

2498

1868

cert = cert_list[0]

2499

1869

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

2500

2501

@staticmethod

2502

def key_id(certificate):

2503

"Convert a certificate bytestring to a hexdigit key ID"

2504

# New GnuTLS "datum" with the public key

2505

datum = gnutls.datum_t(

2506

ctypes.cast(ctypes.c_char_p(certificate),

2507

ctypes.POINTER(ctypes.c_ubyte)),

2508

ctypes.c_uint(len(certificate)))

2509

# XXX all these need to be created in the gnutls "module"

2510

# New empty GnuTLS certificate

2511

pubkey = gnutls.pubkey_t()

2512

gnutls.pubkey_init(ctypes.byref(pubkey))

2513

# Import the raw public key into the certificate

2514

gnutls.pubkey_import(pubkey,

2515

ctypes.byref(datum),

2516

gnutls.X509_FMT_DER)

2517

# New buffer for the key ID

2518

buf = ctypes.create_string_buffer(32)

2519

buf_len = ctypes.c_size_t(len(buf))

2520

# Get the key ID from the raw public key into the buffer

2521

gnutls.pubkey_get_key_id(

2522

pubkey,

2523

gnutls.KEYID_USE_SHA256,

2524

ctypes.cast(ctypes.byref(buf),

2525

ctypes.POINTER(ctypes.c_ubyte)),

2526

ctypes.byref(buf_len))

2527

# Deinit the certificate

2528

gnutls.pubkey_deinit(pubkey)

2529

2530

# Convert the buffer to a Python bytestring

2531

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

2532

# Convert the bytestring to hexadecimal notation

2533

hex_key_id = binascii.hexlify(key_id).upper()

2534

return hex_key_id

2535

1870

2536

1871

@staticmethod

2537

1872

def fingerprint(openpgp):

2538

1873

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2539

1874

# New GnuTLS "datum" with the OpenPGP public key

2540

datum = gnutls.datum_t(

1875

datum = gnutls.library.types.gnutls_datum_t(

2541

1876

ctypes.cast(ctypes.c_char_p(openpgp),

2542

1877

ctypes.POINTER(ctypes.c_ubyte)),

2543

1878

ctypes.c_uint(len(openpgp)))

2544

1879

# New empty GnuTLS certificate

2545

crt = gnutls.openpgp_crt_t()

2546

gnutls.openpgp_crt_init(ctypes.byref(crt))

1880

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1881

gnutls.library.functions.gnutls_openpgp_crt_init(

1882

ctypes.byref(crt))

2547

1883

# Import the OpenPGP public key into the certificate

2548

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

2549

gnutls.OPENPGP_FMT_RAW)

1884

gnutls.library.functions.gnutls_openpgp_crt_import(

1885

crt, ctypes.byref(datum),

1886

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

2550

1887

# Verify the self signature in the key

2551

1888

crtverify = ctypes.c_uint()

2552

gnutls.openpgp_crt_verify_self(crt, 0,

2553

ctypes.byref(crtverify))

1889

gnutls.library.functions.gnutls_openpgp_crt_verify_self(

1890

crt, 0, ctypes.byref(crtverify))

2554

1891

if crtverify.value != 0:

2555

gnutls.openpgp_crt_deinit(crt)

2556

raise gnutls.CertificateSecurityError(code

2557

=crtverify.value)

1892

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1893

raise gnutls.errors.CertificateSecurityError(

1894

"Verify failed")

2558

1895

# New buffer for the fingerprint

2559

1896

buf = ctypes.create_string_buffer(20)

2560

1897

buf_len = ctypes.c_size_t()

2561

1898

# Get the fingerprint from the certificate into the buffer

2562

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

2563

ctypes.byref(buf_len))

1899

gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(

1900

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

2564

1901

# Deinit the certificate

2565

gnutls.openpgp_crt_deinit(crt)

1902

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2566

1903

# Convert the buffer to a Python bytestring

2567

1904

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

2568

1905

# Convert the bytestring to hexadecimal notation

2570

1907

return hex_fpr

2571

1908

2572

1909

2573

class MultiprocessingMixIn:

1910

class MultiprocessingMixIn(object):

2574

1911

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

2575

1912

2576

1913

def sub_process_main(self, request, address):

2577

1914

try:

2578

1915

self.finish_request(request, address)

2579

1916

except Exception:

2580

1917

self.handle_error(request, address)

2581

1918

self.close_request(request)

2582

1919

2583

1920

def process_request(self, request, address):

2584

1921

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

2585

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

2586

args=(request, address))

1922

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

1923

args = (request, address))

2587

1924

proc.start()

2588

1925

return proc

2589

1926

2590

1927

2591

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1928

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2592

1929

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

2593

1930

2594

1931

def process_request(self, request, client_address):

2595

1932

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

2596

1933

2597

1934

This function creates a new pipe in self.pipe

2598

1935

"""

2599

1936

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2600

1937

2601

1938

proc = MultiprocessingMixIn.process_request(self, request,

2602

1939

client_address)

2603

1940

self.child_pipe.close()

2604

1941

self.add_pipe(parent_pipe, proc)

2605

1942

2606

1943

def add_pipe(self, parent_pipe, proc):

2607

1944

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

2608

1945

raise NotImplementedError()

2609

1946

2610

1947

2611

1948

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2612

socketserver.TCPServer):

2613

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

2614

1949

socketserver.TCPServer, object):

1950

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

1951

2615

1952

Attributes:

2616

1953

enabled: Boolean; whether this server is activated yet

2617

1954

interface: None or a network interface name (string)

2618

1955

use_ipv6: Boolean; to use IPv6 or not

2619

1956

"""

2620

1957

2621

1958

def __init__(self, server_address, RequestHandlerClass,

2622

1959

interface=None,

2623

1960

use_ipv6=True,

2633

1970

self.socketfd = socketfd

2634

1971

# Save the original socket.socket() function

2635

1972

self.socket_socket = socket.socket

2636

2637

1973

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

2638

#

1974

#

2639

1975

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

2640

1976

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

2641

1977

# patching socket.socket.)

2642

#

1978

#

2643

1979

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

2644

1980

@functools.wraps(socket.socket)

2645

1981

def socket_wrapper(*args, **kwargs):

2657

1993

# socket_wrapper(), if socketfd was set.

2658

1994

socketserver.TCPServer.__init__(self, server_address,

2659

1995

RequestHandlerClass)

2660

1996

2661

1997

def server_bind(self):

2662

1998

"""This overrides the normal server_bind() function

2663

1999

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

2664

2000

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

2665

global SO_BINDTODEVICE

2666

2001

if self.interface is not None:

2667

2002

if SO_BINDTODEVICE is None:

2668

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

2669

# common enough.

2670

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

2671

SO_BINDTODEVICE = 25

2672

try:

2673

self.socket.setsockopt(

2674

socket.SOL_SOCKET, SO_BINDTODEVICE,

2675

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

2676

except socket.error as error:

2677

if error.errno == errno.EPERM:

2678

log.error("No permission to bind to interface %s",

2679

self.interface)

2680

elif error.errno == errno.ENOPROTOOPT:

2681

log.error("SO_BINDTODEVICE not available; cannot"

2682

" bind to interface %s", self.interface)

2683

elif error.errno == errno.ENODEV:

2684

log.error("Interface %s does not exist, cannot"

2685

" bind", self.interface)

2686

else:

2687

raise

2003

logger.error("SO_BINDTODEVICE does not exist;"

2004

" cannot bind to interface %s",

2005

self.interface)

2006

else:

2007

try:

2008

self.socket.setsockopt(

2009

socket.SOL_SOCKET, SO_BINDTODEVICE,

2010

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

2011

except socket.error as error:

2012

if error.errno == errno.EPERM:

2013

logger.error("No permission to bind to"

2014

" interface %s", self.interface)

2015

elif error.errno == errno.ENOPROTOOPT:

2016

logger.error("SO_BINDTODEVICE not available;"

2017

" cannot bind to interface %s",

2018

self.interface)

2019

elif error.errno == errno.ENODEV:

2020

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

2021

" cannot bind", self.interface)

2022

else:

2023

raise

2688

2024

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

2689

2025

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

2690

if self.server_address[1]:

2691

self.allow_reuse_address = True

2692

2026

if not self.server_address[0]:

2693

2027

if self.address_family == socket.AF_INET6:

2694

any_address = "::" # in6addr_any

2028

any_address = "::" # in6addr_any

2695

2029

else:

2696

any_address = "0.0.0.0" # INADDR_ANY

2030

any_address = "0.0.0.0" # INADDR_ANY

2697

2031

self.server_address = (any_address,

2698

2032

self.server_address[1])

2699

2033

elif not self.server_address[1]:

2709

2043

2710

2044

class MandosServer(IPv6_TCPServer):

2711

2045

"""Mandos server.

2712

2046

2713

2047

Attributes:

2714

2048

clients: set of Client objects

2715

2049

gnutls_priority GnuTLS priority string

2716

2050

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

2717

2718

Assumes a GLib.MainLoop event loop.

2051

2052

Assumes a gobject.MainLoop event loop.

2719

2053

"""

2720

2054

2721

2055

def __init__(self, server_address, RequestHandlerClass,

2722

2056

interface=None,

2723

2057

use_ipv6=True,

2733

2067

self.gnutls_priority = gnutls_priority

2734

2068

IPv6_TCPServer.__init__(self, server_address,

2735

2069

RequestHandlerClass,

2736

interface=interface,

2737

use_ipv6=use_ipv6,

2738

socketfd=socketfd)

2739

2070

interface = interface,

2071

use_ipv6 = use_ipv6,

2072

socketfd = socketfd)

2073

2740

2074

def server_activate(self):

2741

2075

if self.enabled:

2742

2076

return socketserver.TCPServer.server_activate(self)

2743

2077

2744

2078

def enable(self):

2745

2079

self.enabled = True

2746

2080

2747

2081

def add_pipe(self, parent_pipe, proc):

2748

2082

# Call "handle_ipc" for both data and EOF events

2749

GLib.io_add_watch(

2750

GLib.IOChannel.unix_new(parent_pipe.fileno()),

2751

GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,

2083

gobject.io_add_watch(

2084

parent_pipe.fileno(),

2085

gobject.IO_IN | gobject.IO_HUP,

2752

2086

functools.partial(self.handle_ipc,

2753

parent_pipe=parent_pipe,

2754

proc=proc))

2755

2087

parent_pipe = parent_pipe,

2088

proc = proc))

2089

2756

2090

def handle_ipc(self, source, condition,

2757

2091

parent_pipe=None,

2758

proc=None,

2092

proc = None,

2759

2093

client_object=None):

2760

2094

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

2761

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

2095

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

2762

2096

# Wait for other process to exit

2763

2097

proc.join()

2764

2098

return False

2765

2099

2766

2100

# Read a request from the child

2767

2101

request = parent_pipe.recv()

2768

2102

command = request[0]

2769

2770

if command == "init":

2771

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

2772

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

2773

address = request[3]

2774

2775

for c in self.clients.values():

2776

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2777

"27AE41E4649B934CA495991B7852B855"):

2778

continue

2779

if key_id and c.key_id == key_id:

2780

client = c

2781

break

2782

if fpr and c.fingerprint == fpr:

2103

2104

if command == 'init':

2105

fpr = request[1]

2106

address = request[2]

2107

2108

for c in self.clients.itervalues():

2109

if c.fingerprint == fpr:

2783

2110

client = c

2784

2111

break

2785

2112

else:

2786

log.info("Client not found for key ID: %s, address:"

2787

" %s", key_id or fpr, address)

2113

logger.info("Client not found for fingerprint: %s, ad"

2114

"dress: %s", fpr, address)

2788

2115

if self.use_dbus:

2789

2116

# Emit D-Bus signal

2790

mandos_dbus_service.ClientNotFound(key_id or fpr,

2117

mandos_dbus_service.ClientNotFound(fpr,

2791

2118

address[0])

2792

2119

parent_pipe.send(False)

2793

2120

return False

2794

2795

GLib.io_add_watch(

2796

GLib.IOChannel.unix_new(parent_pipe.fileno()),

2797

GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,

2121

2122

gobject.io_add_watch(

2123

parent_pipe.fileno(),

2124

gobject.IO_IN | gobject.IO_HUP,

2798

2125

functools.partial(self.handle_ipc,

2799

parent_pipe=parent_pipe,

2800

proc=proc,

2801

client_object=client))

2126

parent_pipe = parent_pipe,

2127

proc = proc,

2128

client_object = client))

2802

2129

parent_pipe.send(True)

2803

2130

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

2804

2131

# same fileno

2805

2132

return False

2806

if command == "funcall":

2133

if command == 'funcall':

2807

2134

funcname = request[1]

2808

2135

args = request[2]

2809

2136

kwargs = request[3]

2810

2811

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

2137

2138

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

2812

2139

funcname)(*args,

2813

2140

**kwargs)))

2814

2815

if command == "getattr":

2141

2142

if command == 'getattr':

2816

2143

attrname = request[1]

2817

2144

if isinstance(client_object.__getattribute__(attrname),

2818

collections.abc.Callable):

2819

parent_pipe.send(("function", ))

2145

collections.Callable):

2146

parent_pipe.send(('function', ))

2820

2147

else:

2821

2148

parent_pipe.send((

2822

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

2823

2824

if command == "setattr":

2149

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

2150

2151

if command == 'setattr':

2825

2152

attrname = request[1]

2826

2153

value = request[2]

2827

2154

setattr(client_object, attrname, value)

2828

2155

2829

2156

return True

2830

2157

2831

2158

2832

2159

def rfc3339_duration_to_delta(duration):

2833

2160

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

2834

2835

>>> timedelta = datetime.timedelta

2836

>>> rfc3339_duration_to_delta("P7D") == timedelta(7)

2837

True

2838

>>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)

2839

True

2840

>>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)

2841

True

2842

>>> rfc3339_duration_to_delta("PT24H") == timedelta(1)

2843

True

2844

>>> rfc3339_duration_to_delta("P1W") == timedelta(7)

2845

True

2846

>>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)

2847

True

2848

>>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)

2849

True

2850

>>> del timedelta

2161

2162

>>> rfc3339_duration_to_delta("P7D")

2163

datetime.timedelta(7)

2164

>>> rfc3339_duration_to_delta("PT60S")

2165

datetime.timedelta(0, 60)

2166

>>> rfc3339_duration_to_delta("PT60M")

2167

datetime.timedelta(0, 3600)

2168

>>> rfc3339_duration_to_delta("PT24H")

2169

datetime.timedelta(1)

2170

>>> rfc3339_duration_to_delta("P1W")

2171

datetime.timedelta(7)

2172

>>> rfc3339_duration_to_delta("PT5M30S")

2173

datetime.timedelta(0, 330)

2174

>>> rfc3339_duration_to_delta("P1DT3M20S")

2175

datetime.timedelta(1, 200)

2851

2176

"""

2852

2177

2853

2178

# Parsing an RFC 3339 duration with regular expressions is not

2854

2179

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

2855

2180

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

2856

2181

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

2857

2182

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

2858

2183

# avoid excessive use of external libraries.

2859

2184

2860

2185

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

2861

2186

Token = collections.namedtuple("Token", (

2862

2187

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

2895

2220

frozenset((token_year, token_month,

2896

2221

token_day, token_time,

2897

2222

token_week)))

2898

# Define starting values:

2899

# Value so far

2900

value = datetime.timedelta()

2223

# Define starting values

2224

value = datetime.timedelta() # Value so far

2901

2225

found_token = None

2902

# Following valid tokens

2903

followers = frozenset((token_duration, ))

2904

# String left to parse

2905

s = duration

2226

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

2227

s = duration # String left to parse

2906

2228

# Loop until end token is found

2907

2229

while found_token is not token_end:

2908

2230

# Search for any currently valid tokens

2932

2254

2933

2255

def string_to_delta(interval):

2934

2256

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

2935

2936

>>> string_to_delta("7d") == datetime.timedelta(7)

2937

True

2938

>>> string_to_delta("60s") == datetime.timedelta(0, 60)

2939

True

2940

>>> string_to_delta("60m") == datetime.timedelta(0, 3600)

2941

True

2942

>>> string_to_delta("24h") == datetime.timedelta(1)

2943

True

2944

>>> string_to_delta("1w") == datetime.timedelta(7)

2945

True

2946

>>> string_to_delta("5m 30s") == datetime.timedelta(0, 330)

2947

True

2257

2258

>>> string_to_delta('7d')

2259

datetime.timedelta(7)

2260

>>> string_to_delta('60s')

2261

datetime.timedelta(0, 60)

2262

>>> string_to_delta('60m')

2263

datetime.timedelta(0, 3600)

2264

>>> string_to_delta('24h')

2265

datetime.timedelta(1)

2266

>>> string_to_delta('1w')

2267

datetime.timedelta(7)

2268

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

2269

datetime.timedelta(0, 330)

2948

2270

"""

2949

2271

2950

2272

try:

2951

2273

return rfc3339_duration_to_delta(interval)

2952

2274

except ValueError:

2953

2275

pass

2954

2276

2955

2277

timevalue = datetime.timedelta(0)

2956

2278

for s in interval.split():

2957

2279

try:

2975

2297

return timevalue

2976

2298

2977

2299

2978

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

2300

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

2979

2301

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

2980

2302

2981

2303

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

2982

2304

if os.fork():

2983

2305

sys.exit()

3001

2323

3002

2324

3003

2325

def main():

3004

2326

3005

2327

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

3006

2328

# Parsing of options, both command line and config file

3007

2329

3008

2330

parser = argparse.ArgumentParser()

3009

2331

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

3010

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

2332

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

3011

2333

help="show version number and exit")

3012

2334

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

3013

2335

help="Bind to interface IF")

3049

2371

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

3050

2372

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

3051

2373

default=None)

3052

2374

3053

2375

options = parser.parse_args()

3054

2376

2377

if options.check:

2378

import doctest

2379

fail_count, test_count = doctest.testmod()

2380

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

2381

3055

2382

# Default values for config file for server-global settings

3056

if gnutls.has_rawpk:

3057

priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"

3058

":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")

3059

else:

3060

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

3061

":+SIGN-DSA-SHA256")

3062

server_defaults = {"interface": "",

3063

"address": "",

3064

"port": "",

3065

"debug": "False",

3066

"priority": priority,

3067

"servicename": "Mandos",

3068

"use_dbus": "True",

3069

"use_ipv6": "True",

3070

"debuglevel": "",

3071

"restore": "True",

3072

"socket": "",

3073

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

3074

"foreground": "False",

3075

"zeroconf": "True",

3076

}

3077

del priority

3078

2383

server_defaults = { "interface": "",

2384

"address": "",

2385

"port": "",

2386

"debug": "False",

2387

"priority":

2388

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

2389

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

2390

"servicename": "Mandos",

2391

"use_dbus": "True",

2392

"use_ipv6": "True",

2393

"debuglevel": "",

2394

"restore": "True",

2395

"socket": "",

2396

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

2397

"foreground": "False",

2398

"zeroconf": "True",

2399

}

2400

3079

2401

# Parse config file for server-global settings

3080

server_config = configparser.ConfigParser(server_defaults)

2402

server_config = configparser.SafeConfigParser(server_defaults)

3081

2403

del server_defaults

3082

2404

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

3083

# Convert the ConfigParser object to a dict

2405

# Convert the SafeConfigParser object to a dict

3084

2406

server_settings = server_config.defaults()

3085

2407

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

3086

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

3087

"foreground", "zeroconf"):

2408

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

3088

2409

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

3089

2410

option)

3090

2411

if server_settings["port"]:

3100

2421

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

3101

2422

["socket"])

3102

2423

del server_config

3103

2424

3104

2425

# Override the settings from the config file with command line

3105

2426

# options, if set.

3106

2427

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

3124

2445

if server_settings["debug"]:

3125

2446

server_settings["foreground"] = True

3126

2447

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

3127

2448

3128

2449

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

3129

2450

3130

2451

if (not server_settings["zeroconf"]

3131

2452

and not (server_settings["port"]

3132

2453

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

3133

2454

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

3134

2455

3135

2456

# For convenience

3136

2457

debug = server_settings["debug"]

3137

2458

debuglevel = server_settings["debuglevel"]

3141

2462

stored_state_file)

3142

2463

foreground = server_settings["foreground"]

3143

2464

zeroconf = server_settings["zeroconf"]

3144

2465

3145

2466

if debug:

3146

2467

initlogger(debug, logging.DEBUG)

3147

2468

else:

3150

2471

else:

3151

2472

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

3152

2473

initlogger(debug, level)

3153

2474

3154

2475

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

3155

2476

syslogger.setFormatter(

3156

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

3157

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

2477

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

2478

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

3158

2479

server_settings["servicename"])))

3159

2480

3160

2481

# Parse config file with clients

3161

client_config = configparser.ConfigParser(Client.client_defaults)

2482

client_config = configparser.SafeConfigParser(Client

2483

.client_defaults)

3162

2484

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

3163

2485

"clients.conf"))

3164

2486

3165

2487

global mandos_dbus_service

3166

2488

mandos_dbus_service = None

3167

2489

3168

2490

socketfd = None

3169

2491

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

3170

2492

socketfd = server_settings["socket"]

3184

2506

try:

3185

2507

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

3186

2508

except IOError as e:

3187

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

3188

exc_info=e)

3189

3190

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

3191

("mandos", "mandos"),

3192

("nobody", "nogroup")):

2509

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

2510

exc_info=e)

2511

2512

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

3193

2513

try:

3194

2514

uid = pwd.getpwnam(name).pw_uid

3195

gid = pwd.getpwnam(group).pw_gid

2515

gid = pwd.getpwnam(name).pw_gid

3196

2516

break

3197

2517

except KeyError:

3198

2518

continue

3202

2522

try:

3203

2523

os.setgid(gid)

3204

2524

os.setuid(uid)

3205

log.debug("Did setuid/setgid to %s:%s", uid, gid)

3206

2525

except OSError as error:

3207

log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,

3208

os.strerror(error.errno))

3209

2526

if error.errno != errno.EPERM:

3210

2527

raise

3211

2528

3212

2529

if debug:

3213

2530

# Enable all possible GnuTLS debugging

3214

2531

3215

2532

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

3216

2533

# - GnuTLS manual

3217

gnutls.global_set_log_level(11)

3218

3219

@gnutls.log_func

2534

gnutls.library.functions.gnutls_global_set_log_level(11)

2535

2536

@gnutls.library.types.gnutls_log_func

3220

2537

def debug_gnutls(level, string):

3221

log.debug("GnuTLS: %s",

3222

string[:-1].decode("utf-8", errors="replace"))

3223

3224

gnutls.global_set_log_function(debug_gnutls)

3225

2538

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

2539

2540

gnutls.library.functions.gnutls_global_set_log_function(

2541

debug_gnutls)

2542

3226

2543

# Redirect stdin so all checkers get /dev/null

3227

2544

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

3228

2545

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

3229

2546

if null > 2:

3230

2547

os.close(null)

3231

2548

3232

2549

# Need to fork before connecting to D-Bus

3233

2550

if not foreground:

3234

2551

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

3235

2552

daemon()

3236

3237

if gi.version_info < (3, 10, 2):

3238

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

3239

# need to inform GLib that threads will be used.

3240

GLib.threads_init()

3241

2553

2554

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

2555

# need to inform gobject that threads will be used.

2556

gobject.threads_init()

2557

3242

2558

global main_loop

3243

2559

# From the Avahi example code

3244

2560

DBusGMainLoop(set_as_default=True)

3245

main_loop = GLib.MainLoop()

2561

main_loop = gobject.MainLoop()

3246

2562

bus = dbus.SystemBus()

3247

2563

# End of Avahi example code

3248

2564

if use_dbus:

3254

2570

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

3255

2571

do_not_queue=True)

3256

2572

except dbus.exceptions.DBusException as e:

3257

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

2573

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

3258

2574

use_dbus = False

3259

2575

server_settings["use_dbus"] = False

3260

2576

tcp_server.use_dbus = False

3261

2577

if zeroconf:

3262

2578

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3263

2579

service = AvahiServiceToSyslog(

3264

name=server_settings["servicename"],

3265

servicetype="_mandos._tcp",

3266

protocol=protocol,

3267

bus=bus)

2580

name = server_settings["servicename"],

2581

servicetype = "_mandos._tcp",

2582

protocol = protocol,

2583

bus = bus)

3268

2584

if server_settings["interface"]:

3269

2585

service.interface = if_nametoindex(

3270

2586

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

3271

2587

3272

2588

global multiprocessing_manager

3273

2589

multiprocessing_manager = multiprocessing.Manager()

3274

2590

3275

2591

client_class = Client

3276

2592

if use_dbus:

3277

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

3278

2593

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

2594

3279

2595

client_settings = Client.config_parser(client_config)

3280

2596

old_client_settings = {}

3281

2597

clients_data = {}

3282

2598

3283

2599

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

3284

2600

global wnull

3285

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

2601

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

3286

2602

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

3287

2603

# mode

3288

2604

if debug or not foreground:

3289

2605

wnull.close()

3290

2606

3291

2607

# Get client data and settings from last running state.

3292

2608

if server_settings["restore"]:

3293

2609

try:

3294

2610

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

3295

if sys.version_info.major == 2:

3296

clients_data, old_client_settings = pickle.load(

3297

stored_state)

3298

else:

3299

bytes_clients_data, bytes_old_client_settings = (

3300

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

3301

# Fix bytes to strings

3302

# clients_data

3303

# .keys()

3304

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

3305

if isinstance(key, bytes)

3306

else key): value

3307

for key, value in

3308

bytes_clients_data.items()}

3309

del bytes_clients_data

3310

for key in clients_data:

3311

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

3312

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

3313

for k, v in

3314

clients_data[key].items()}

3315

clients_data[key] = value

3316

# .client_structure

3317

value["client_structure"] = [

3318

(s.decode("utf-8")

3319

if isinstance(s, bytes)

3320

else s) for s in

3321

value["client_structure"]]

3322

# .name, .host, and .checker_command

3323

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

3324

if isinstance(value[k], bytes):

3325

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

3326

if "key_id" not in value:

3327

value["key_id"] = ""

3328

elif "fingerprint" not in value:

3329

value["fingerprint"] = ""

3330

# old_client_settings

3331

# .keys()

3332

old_client_settings = {

3333

(key.decode("utf-8")

3334

if isinstance(key, bytes)

3335

else key): value

3336

for key, value in

3337

bytes_old_client_settings.items()}

3338

del bytes_old_client_settings

3339

# .host and .checker_command

3340

for value in old_client_settings.values():

3341

for attribute in ("host", "checker_command"):

3342

if isinstance(value[attribute], bytes):

3343

value[attribute] = (value[attribute]

3344

.decode("utf-8"))

2611

clients_data, old_client_settings = pickle.load(

2612

stored_state)

3345

2613

os.remove(stored_state_path)

3346

2614

except IOError as e:

3347

2615

if e.errno == errno.ENOENT:

3348

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

3349

" %s", os.strerror(e.errno))

2616

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

2617

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

3350

2618

else:

3351

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

3352

exc_info=e)

2619

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

2620

exc_info=e)

3353

2621

raise

3354

2622

except EOFError as e:

3355

log.warning("Could not load persistent state: EOFError:",

3356

exc_info=e)

3357

2623

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

2624

"EOFError:",

2625

exc_info=e)

2626

3358

2627

with PGPEngine() as pgp:

3359

2628

for client_name, client in clients_data.items():

3360

2629

# Skip removed clients

3361

2630

if client_name not in client_settings:

3362

2631

continue

3363

2632

3364

2633

# Decide which value to use after restoring saved state.

3365

2634

# We have three different values: Old config file,

3366

2635

# new config file, and saved state.

3377

2646

client[name] = value

3378

2647

except KeyError:

3379

2648

pass

3380

2649

3381

2650

# Clients who has passed its expire date can still be

3382

2651

# enabled if its last checker was successful. A Client

3383

2652

# whose checker succeeded before we stored its state is

3386

2655

if client["enabled"]:

3387

2656

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

3388

2657

if not client["last_checked_ok"]:

3389

log.warning("disabling client %s - Client"

3390

" never performed a successful"

3391

" checker", client_name)

2658

logger.warning(

2659

"disabling client {} - Client never "

2660

"performed a successful checker".format(

2661

client_name))

3392

2662

client["enabled"] = False

3393

2663

elif client["last_checker_status"] != 0:

3394

log.warning("disabling client %s - Client"

3395

" last checker failed with error"

3396

" code %s", client_name,

3397

client["last_checker_status"])

2664

logger.warning(

2665

"disabling client {} - Client last"

2666

" checker failed with error code"

2667

" {}".format(

2668

client_name,

2669

client["last_checker_status"]))

3398

2670

client["enabled"] = False

3399

2671

else:

3400

2672

client["expires"] = (

3401

2673

datetime.datetime.utcnow()

3402

2674

+ client["timeout"])

3403

log.debug("Last checker succeeded, keeping %s"

3404

" enabled", client_name)

2675

logger.debug("Last checker succeeded,"

2676

" keeping {} enabled".format(

2677

client_name))

3405

2678

try:

3406

2679

client["secret"] = pgp.decrypt(

3407

2680

client["encrypted_secret"],

3408

2681

client_settings[client_name]["secret"])

3409

2682

except PGPError:

3410

2683

# If decryption fails, we use secret from new settings

3411

log.debug("Failed to decrypt %s old secret",

3412

client_name)

2684

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

2685

client_name))

3413

2686

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

3414

2687

["secret"])

3415

2688

3416

2689

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

3417

2690

for client_name in (set(old_client_settings)

3418

2691

- set(client_settings)):

3420

2693

for client_name in (set(client_settings)

3421

2694

- set(old_client_settings)):

3422

2695

clients_data[client_name] = client_settings[client_name]

3423

2696

3424

2697

# Create all client objects

3425

2698

for client_name, client in clients_data.items():

3426

2699

tcp_server.clients[client_name] = client_class(

3427

name=client_name,

3428

settings=client,

3429

server_settings=server_settings)

3430

2700

name = client_name,

2701

settings = client,

2702

server_settings = server_settings)

2703

3431

2704

if not tcp_server.clients:

3432

log.warning("No clients defined")

3433

2705

logger.warning("No clients defined")

2706

3434

2707

if not foreground:

3435

2708

if pidfile is not None:

3436

2709

pid = os.getpid()

3438

2711

with pidfile:

3439

2712

print(pid, file=pidfile)

3440

2713

except IOError:

3441

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

3442

pidfilename, pid)

2714

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

2715

pidfilename, pid)

3443

2716

del pidfile

3444

2717

del pidfilename

3445

3446

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

3447

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3448

lambda: main_loop.quit() and False)

3449

2718

2719

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

2720

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

2721

3450

2722

if use_dbus:

3451

2723

3452

2724

@alternate_dbus_interfaces(

3453

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

3454

class MandosDBusService(DBusObjectWithObjectManager):

2725

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

2726

class MandosDBusService(DBusObjectWithProperties):

3455

2727

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

3456

2728

3457

2729

def __init__(self):

3458

2730

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

3459

2731

3460

2732

_interface = "se.recompile.Mandos"

3461

2733

2734

@dbus_interface_annotations(_interface)

2735

def _foo(self):

2736

return {

2737

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

2738

"false" }

2739

3462

2740

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

3463

2741

def ClientAdded(self, objpath):

3464

2742

"D-Bus signal"

3465

2743

pass

3466

2744

3467

2745

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

3468

def ClientNotFound(self, key_id, address):

2746

def ClientNotFound(self, fingerprint, address):

3469

2747

"D-Bus signal"

3470

2748

pass

3471

3472

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

3473

"true"})

2749

3474

2750

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

3475

2751

def ClientRemoved(self, objpath, name):

3476

2752

"D-Bus signal"

3477

2753

pass

3478

3479

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

3480

"true"})

2754

3481

2755

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

3482

2756

def GetAllClients(self):

3483

2757

"D-Bus method"

3484

2758

return dbus.Array(c.dbus_object_path for c in

3485

tcp_server.clients.values())

3486

3487

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

3488

"true"})

2759

tcp_server.clients.itervalues())

2760

3489

2761

@dbus.service.method(_interface,

3490

2762

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

3491

2763

def GetAllClientsWithProperties(self):

3492

2764

"D-Bus method"

3493

2765

return dbus.Dictionary(

3494

{c.dbus_object_path: c.GetAll(

3495

"se.recompile.Mandos.Client")

3496

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

2766

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

2767

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

3497

2768

signature="oa{sv}")

3498

2769

3499

2770

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

3500

2771

def RemoveClient(self, object_path):

3501

2772

"D-Bus method"

3502

for c in tcp_server.clients.values():

2773

for c in tcp_server.clients.itervalues():

3503

2774

if c.dbus_object_path == object_path:

3504

2775

del tcp_server.clients[c.name]

3505

2776

c.remove_from_connection()

3506

# Don't signal the disabling

2777

# Don't signal anything except ClientRemoved

3507

2778

c.disable(quiet=True)

3508

# Emit D-Bus signal for removal

3509

self.client_removed_signal(c)

2779

# Emit D-Bus signal

2780

self.ClientRemoved(object_path, c.name)

3510

2781

return

3511

2782

raise KeyError(object_path)

3512

2783

3513

2784

del _interface

3514

3515

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3516

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

3517

def GetManagedObjects(self):

3518

"""D-Bus method"""

3519

return dbus.Dictionary(

3520

{client.dbus_object_path:

3521

dbus.Dictionary(

3522

{interface: client.GetAll(interface)

3523

for interface in

3524

client._get_all_interface_names()})

3525

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

3526

3527

def client_added_signal(self, client):

3528

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

3529

if use_dbus:

3530

# New standard signal

3531

self.InterfacesAdded(

3532

client.dbus_object_path,

3533

dbus.Dictionary(

3534

{interface: client.GetAll(interface)

3535

for interface in

3536

client._get_all_interface_names()}))

3537

# Old signal

3538

self.ClientAdded(client.dbus_object_path)

3539

3540

def client_removed_signal(self, client):

3541

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

3542

if use_dbus:

3543

# New standard signal

3544

self.InterfacesRemoved(

3545

client.dbus_object_path,

3546

client._get_all_interface_names())

3547

# Old signal

3548

self.ClientRemoved(client.dbus_object_path,

3549

client.name)

3550

2785

3551

2786

mandos_dbus_service = MandosDBusService()

3552

3553

# Save modules to variables to exempt the modules from being

3554

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

3555

mp = multiprocessing

3556

wn = wnull

3557

2787

3558

2788

def cleanup():

3559

2789

"Cleanup function; run on exit"

3560

2790

if zeroconf:

3561

2791

service.cleanup()

3562

3563

mp.active_children()

3564

wn.close()

2792

2793

multiprocessing.active_children()

2794

wnull.close()

3565

2795

if not (tcp_server.clients or client_settings):

3566

2796

return

3567

2797

3568

2798

# Store client before exiting. Secrets are encrypted with key

3569

2799

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

3570

2800

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

3571

2801

clients = {}

3572

2802

with PGPEngine() as pgp:

3573

for client in tcp_server.clients.values():

2803

for client in tcp_server.clients.itervalues():

3574

2804

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

3575

2805

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

3576

2806

key)

3577

2807

client_dict = {}

3578

2808

3579

2809

# A list of attributes that can not be pickled

3580

2810

# + secret.

3581

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

3582

"checker", "server_settings"}

2811

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

2812

"checker", "server_settings" }

3583

2813

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

3584

2814

.Object):

3585

2815

exclude.add(name)

3586

2816

3587

2817

client_dict["encrypted_secret"] = (client

3588

2818

.encrypted_secret)

3589

2819

for attr in client.client_structure:

3590

2820

if attr not in exclude:

3591

2821

client_dict[attr] = getattr(client, attr)

3592

2822

3593

2823

clients[client.name] = client_dict

3594

2824

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

3595

2825

3596

2826

try:

3597

2827

with tempfile.NamedTemporaryFile(

3598

mode="wb",

2828

mode='wb',

3599

2829

suffix=".pickle",

3600

prefix="clients-",

2830

prefix='clients-',

3601

2831

dir=os.path.dirname(stored_state_path),

3602

2832

delete=False) as stored_state:

3603

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

3604

protocol=2)

2833

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

3605

2834

tempname = stored_state.name

3606

2835

os.rename(tempname, stored_state_path)

3607

2836

except (IOError, OSError) as e:

3611

2840

except NameError:

3612

2841

pass

3613

2842

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

3614

log.warning("Could not save persistent state: %s",

3615

os.strerror(e.errno))

2843

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

2844

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

3616

2845

else:

3617

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

3618

exc_info=e)

2846

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

2847

exc_info=e)

3619

2848

raise

3620

2849

3621

2850

# Delete all clients, and settings from config

3622

2851

while tcp_server.clients:

3623

2852

name, client = tcp_server.clients.popitem()

3624

2853

if use_dbus:

3625

2854

client.remove_from_connection()

3626

# Don't signal the disabling

2855

# Don't signal anything except ClientRemoved

3627

2856

client.disable(quiet=True)

3628

# Emit D-Bus signal for removal

3629

2857

if use_dbus:

3630

mandos_dbus_service.client_removed_signal(client)

2858

# Emit D-Bus signal

2859

mandos_dbus_service.ClientRemoved(

2860

client.dbus_object_path, client.name)

3631

2861

client_settings.clear()

3632

2862

3633

2863

atexit.register(cleanup)

3634

3635

for client in tcp_server.clients.values():

2864

2865

for client in tcp_server.clients.itervalues():

3636

2866

if use_dbus:

3637

# Emit D-Bus signal for adding

3638

mandos_dbus_service.client_added_signal(client)

2867

# Emit D-Bus signal

2868

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3639

2869

# Need to initiate checking of clients

3640

2870

if client.enabled:

3641

client.init_checker(randomize_start=True)

3642

2871

client.init_checker()

2872

3643

2873

tcp_server.enable()

3644

2874

tcp_server.server_activate()

3645

2875

3646

2876

# Find out what port we got

3647

2877

if zeroconf:

3648

2878

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

3649

2879

if use_ipv6:

3650

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

3651

" scope_id %d", *tcp_server.socket.getsockname())

2880

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

2881

" flowinfo %d, scope_id %d",

2882

*tcp_server.socket.getsockname())

3652

2883

else: # IPv4

3653

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

3654

*tcp_server.socket.getsockname())

3655

3656

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

3657

2884

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

2885

*tcp_server.socket.getsockname())

2886

2887

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

2888

3658

2889

try:

3659

2890

if zeroconf:

3660

2891

# From the Avahi example code

3661

2892

try:

3662

2893

service.activate()

3663

2894

except dbus.exceptions.DBusException as error:

3664

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

2895

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

3665

2896

cleanup()

3666

2897

sys.exit(1)

3667

2898

# End of Avahi example code

3668

3669

GLib.io_add_watch(

3670

GLib.IOChannel.unix_new(tcp_server.fileno()),

3671

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3672

lambda *args, **kwargs: (tcp_server.handle_request

3673

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

3674

3675

log.debug("Starting main loop")

2899

2900

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

2901

lambda *args, **kwargs:

2902

(tcp_server.handle_request

2903

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

2904

2905

logger.debug("Starting main loop")

3676

2906

main_loop.run()

3677

2907

except AvahiError as error:

3678

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

2908

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

3679

2909

cleanup()

3680

2910

sys.exit(1)

3681

2911

except KeyboardInterrupt:

3682

2912

if debug:

3683

2913

print("", file=sys.stderr)

3684

log.debug("Server received KeyboardInterrupt")

3685

log.debug("Server exiting")

2914

logger.debug("Server received KeyboardInterrupt")

2915

logger.debug("Server exiting")

3686

2916

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

3687

2917

cleanup()

3688

2918

3689

3690

def parse_test_args():

3691

# type: () -> argparse.Namespace

3692

parser = argparse.ArgumentParser(add_help=False)

3693

parser.add_argument("--check", action="store_true")

3694

parser.add_argument("--prefix", )

3695

args, unknown_args = parser.parse_known_args()

3696

if args.check:

3697

# Remove test options from sys.argv

3698

sys.argv[1:] = unknown_args

3699

return args

3700

3701

# Add all tests from doctest strings

3702

def load_tests(loader, tests, none):

3703

import doctest

3704

tests.addTests(doctest.DocTestSuite())

3705

return tests

3706

3707

if __name__ == "__main__":

3708

options = parse_test_args()

3709

try:

3710

if options.check:

3711

extra_test_prefix = options.prefix

3712

if extra_test_prefix is not None:

3713

if not (unittest.main(argv=[""], exit=False)

3714

.result.wasSuccessful()):

3715

sys.exit(1)

3716

class ExtraTestLoader(unittest.TestLoader):

3717

testMethodPrefix = extra_test_prefix

3718

# Call using ./scriptname --test [--verbose]

3719

unittest.main(argv=[""], testLoader=ExtraTestLoader())

3720

else:

3721

unittest.main(argv=[""])

3722

else:

3723

main()

3724

finally:

3725

logging.shutdown()

3726

3727

# Local Variables:

3728

# run-tests:

3729

# (lambda (&optional extra)

3730

# (if (not (funcall run-tests-in-test-buffer default-directory

3731

# extra))

3732

# (funcall show-test-buffer-in-test-window)

3733

# (funcall remove-test-window)

3734

# (if extra (message "Extra tests run successfully!"))))

3735

# run-tests-in-test-buffer:

3736

# (lambda (dir &optional extra)

3737

# (with-current-buffer (get-buffer-create "*Test*")

3738

# (setq buffer-read-only nil

3739

# default-directory dir)

3740

# (erase-buffer)

3741

# (compilation-mode))

3742

# (let ((process-result

3743

# (let ((inhibit-read-only t))

3744

# (process-file-shell-command

3745

# (funcall get-command-line extra) nil "*Test*"))))

3746

# (and (numberp process-result)

3747

# (= process-result 0))))

3748

# get-command-line:

3749

# (lambda (&optional extra)

3750

# (let ((quoted-script

3751

# (shell-quote-argument (funcall get-script-name))))

3752

# (format

3753

# (concat "%s --check" (if extra " --prefix=atest" ""))

3754

# quoted-script)))

3755

# get-script-name:

3756

# (lambda ()

3757

# (if (fboundp 'file-local-name)

3758

# (file-local-name (buffer-file-name))

3759

# (or (file-remote-p (buffer-file-name) 'localname)

3760

# (buffer-file-name))))

3761

# remove-test-window:

3762

# (lambda ()

3763

# (let ((test-window (get-buffer-window "*Test*")))

3764

# (if test-window (delete-window test-window))))

3765

# show-test-buffer-in-test-window:

3766

# (lambda ()

3767

# (when (not (get-buffer-window-list "*Test*"))

3768

# (setq next-error-last-buffer (get-buffer "*Test*"))

3769

# (let* ((side (if (>= (window-width) 146) 'right 'bottom))

3770

# (display-buffer-overriding-action

3771

# `((display-buffer-in-side-window) (side . ,side)

3772

# (window-height . fit-window-to-buffer)

3773

# (window-width . fit-window-to-buffer))))

3774

# (display-buffer "*Test*"))))

3775

# eval:

3776

# (progn

3777

# (let* ((run-extra-tests (lambda () (interactive)

3778

# (funcall run-tests t)))

3779

# (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t

3780

# (outer-keymap `(keymap (3 . ,inner-keymap)))) ; C-c

3781

# (setq minor-mode-overriding-map-alist

3782

# (cons `(run-tests . ,outer-keymap)

3783

# minor-mode-overriding-map-alist)))

3784

# (add-hook 'after-save-hook run-tests 90 t))

3785

# End:

2919

2920

if __name__ == '__main__':

2921

main()