/mandos/trunk : revision 749.1.2

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

76

78

import tempfile

77

79

import itertools

78

80

import collections

79

import codecs

80

import random

81

import shlex

82

81

83

82

import dbus

84

83

import dbus.service

85

import gi

86

from gi.repository import GLib

84

try:

85

import gobject

86

except ImportError:

87

from gi.repository import GObject as gobject

88

import avahi

87

89

from dbus.mainloop.glib import DBusGMainLoop

88

90

import ctypes

89

91

import ctypes.util

90

92

import xml.dom.minidom

91

93

import inspect

92

94

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:

95

try:

122

96

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

123

97

except AttributeError:

124

98

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

127

99

from IN import SO_BINDTODEVICE

128

100

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

101

SO_BINDTODEVICE = None

102

103

if sys.version_info.major == 2:

104

str = unicode

105

106

version = "1.6.9"

147

107

stored_state_file = "clients.pickle"

148

108

149

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

150

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

109

logger = logging.getLogger()

151

110

syslogger = None

152

111

153

112

try:

154

113

if_nametoindex = ctypes.cdll.LoadLibrary(

155

114

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

156

115

except (OSError, AttributeError):

157

116

158

117

def if_nametoindex(interface):

159

118

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

160

119

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

165

124

return interface_index

166

125

167

126

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

127

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

185

128

"""init logger and add loglevel"""

186

129

187

130

global syslogger

188

131

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

132

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

133

address = "/dev/log"))

191

134

syslogger.setFormatter(logging.Formatter

192

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

193

" %(message)s"))

194

log.addHandler(syslogger)

195

135

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

136

' %(message)s'))

137

logger.addHandler(syslogger)

138

196

139

if debug:

197

140

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)

141

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

142

' [%(process)d]:'

143

' %(levelname)s:'

144

' %(message)s'))

145

logger.addHandler(console)

146

logger.setLevel(level)

204

147

205

148

206

149

class PGPError(Exception):

208

151

pass

209

152

210

153

211

class PGPEngine:

154

class PGPEngine(object):

212

155

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

213

156

214

157

def __init__(self):

215

158

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

159

self.gnupgargs = ['--batch',

160

'--home', self.tempdir,

161

'--force-mdc',

162

'--quiet',

163

'--no-use-agent']

164

235

165

def __enter__(self):

236

166

return self

237

167

238

168

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

239

169

self._cleanup()

240

170

return False

241

171

242

172

def __del__(self):

243

173

self._cleanup()

244

174

245

175

def _cleanup(self):

246

176

if self.tempdir is not None:

247

177

# Delete contents of tempdir

248

178

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

249

topdown=False):

179

topdown = False):

250

180

for filename in files:

251

181

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

252

182

for dirname in dirs:

254

184

# Remove tempdir

255

185

os.rmdir(self.tempdir)

256

186

self.tempdir = None

257

187

258

188

def password_encode(self, password):

259

189

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

260

190

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

265

195

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

266

196

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

267

197

return encoded

268

198

269

199

def encrypt(self, data, password):

270

200

passphrase = self.password_encode(password)

271

201

with tempfile.NamedTemporaryFile(

272

202

dir=self.tempdir) as passfile:

273

203

passfile.write(passphrase)

274

204

passfile.flush()

275

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

276

"--passphrase-file",

205

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

206

'--passphrase-file',

277

207

passfile.name]

278

208

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

209

stdin = subprocess.PIPE,

210

stdout = subprocess.PIPE,

211

stderr = subprocess.PIPE)

212

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

283

213

if proc.returncode != 0:

284

214

raise PGPError(err)

285

215

return ciphertext

286

216

287

217

def decrypt(self, data, password):

288

218

passphrase = self.password_encode(password)

289

219

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

220

dir = self.tempdir) as passfile:

291

221

passfile.write(passphrase)

292

222

passfile.flush()

293

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

294

"--passphrase-file",

223

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

224

'--passphrase-file',

295

225

passfile.name]

296

226

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

227

stdin = subprocess.PIPE,

228

stdout = subprocess.PIPE,

229

stderr = subprocess.PIPE)

230

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

301

231

if proc.returncode != 0:

302

232

raise PGPError(err)

303

233

return decrypted_plaintext

304

234

305

235

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

236

class AvahiError(Exception):

333

237

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

334

238

self.value = value

344

248

pass

345

249

346

250

347

class AvahiService:

251

class AvahiService(object):

348

252

"""An Avahi (Zeroconf) service.

349

253

350

254

Attributes:

351

255

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

352

256

Used to optionally bind to the specified interface.

353

name: string; Example: "Mandos"

354

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

257

name: string; Example: 'Mandos'

258

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

355

259

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

356

260

port: integer; what port to announce

357

261

TXT: list of strings; TXT record for the service

364

268

server: D-Bus Server

365

269

bus: dbus.SystemBus()

366

270

"""

367

271

368

272

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

273

interface = avahi.IF_UNSPEC,

274

name = None,

275

servicetype = None,

276

port = None,

277

TXT = None,

278

domain = "",

279

host = "",

280

max_renames = 32768,

281

protocol = avahi.PROTO_UNSPEC,

282

bus = None):

379

283

self.interface = interface

380

284

self.name = name

381

285

self.type = servicetype

390

294

self.server = None

391

295

self.bus = bus

392

296

self.entry_group_state_changed_match = None

393

297

394

298

def rename(self, remove=True):

395

299

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

396

300

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)

301

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

302

" after %i retries, exiting.",

303

self.rename_count)

400

304

raise AvahiServiceError("Too many renames")

401

305

self.name = str(

402

306

self.server.GetAlternativeServiceName(self.name))

403

307

self.rename_count += 1

404

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

405

self.name)

308

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

309

self.name)

406

310

if remove:

407

311

self.remove()

408

312

try:

410

314

except dbus.exceptions.DBusException as error:

411

315

if (error.get_dbus_name()

412

316

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

413

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

317

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

414

318

return self.rename(remove=False)

415

319

else:

416

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

320

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

417

321

self.cleanup()

418

322

os._exit(1)

419

323

420

324

def remove(self):

421

325

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

422

326

if self.entry_group_state_changed_match is not None:

424

328

self.entry_group_state_changed_match = None

425

329

if self.group is not None:

426

330

self.group.Reset()

427

331

428

332

def add(self):

429

333

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

430

334

self.remove()

435

339

avahi.DBUS_INTERFACE_ENTRY_GROUP)

436

340

self.entry_group_state_changed_match = (

437

341

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)

342

'StateChanged', self.entry_group_state_changed))

343

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

344

self.name, self.type)

441

345

self.group.AddService(

442

346

self.interface,

443

347

self.protocol,

447

351

dbus.UInt16(self.port),

448

352

avahi.string_array_to_txt_array(self.TXT))

449

353

self.group.Commit()

450

354

451

355

def entry_group_state_changed(self, state, error):

452

356

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

453

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

454

357

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

358

455

359

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

log.debug("Zeroconf service established.")

360

logger.debug("Zeroconf service established.")

457

361

elif state == avahi.ENTRY_GROUP_COLLISION:

458

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

362

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

459

363

self.rename()

460

364

elif state == avahi.ENTRY_GROUP_FAILURE:

461

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

462

str(error))

365

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

366

str(error))

463

367

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

464

368

465

369

def cleanup(self):

466

370

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

467

371

if self.group is not None:

472

376

pass

473

377

self.group = None

474

378

self.remove()

475

379

476

380

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

477

381

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

478

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

382

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

479

383

bad_states = {

480

384

avahi.SERVER_INVALID: "Zeroconf server invalid",

481

385

avahi.SERVER_REGISTERING: None,

485

389

if state in bad_states:

486

390

if bad_states[state] is not None:

487

391

if error is None:

488

log.error(bad_states[state])

392

logger.error(bad_states[state])

489

393

else:

490

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

394

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

491

395

self.cleanup()

492

396

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)

397

self.add()

504

398

else:

505

399

if error is None:

506

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

400

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

507

401

else:

508

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

509

402

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

403

510

404

def activate(self):

511

405

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

512

406

if self.server is None:

523

417

class AvahiServiceToSyslog(AvahiService):

524

418

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

525

419

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

526

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

527

**kwargs)

420

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

528

421

syslogger.setFormatter(logging.Formatter(

529

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

422

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

530

423

.format(self.name)))

531

424

return ret

532

425

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

426

def call_pipe(connection, # : multiprocessing.Connection

864

427

func, *args, **kwargs):

865

428

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

866

429

867

430

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

868

431

return value on the provided multiprocessing.Connection.

869

432

"""

870

433

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

871

434

connection.close()

872

435

873

874

class Client:

436

class Client(object):

875

437

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

876

438

877

439

Attributes:

878

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

440

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

879

441

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

880

442

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

443

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

444

to see if the client lives.

445

'None' if no process is running.

446

checker_callback_tag: a gobject event source tag, or None

885

447

checker_command: string; External command which is run to check

886

448

if client lives. %() expansions are done at

887

449

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

888

450

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

889

checker_initiator_tag: a GLib event source tag, or None

451

checker_initiator_tag: a gobject event source tag, or None

890

452

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

891

453

client_structure: Object describing what attributes a client has

892

454

and is used for storing the client at exit

893

455

current_checker_command: string; current running checker_command

894

disable_initiator_tag: a GLib event source tag, or None

456

disable_initiator_tag: a gobject event source tag, or None

895

457

enabled: bool()

896

458

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

459

uniquely identify the client

900

460

host: string; available for use by the checker command

901

461

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

902

462

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

918

478

disabled, or None

919

479

server_settings: The server_settings dict from main()

920

480

"""

921

481

922

482

runtime_expansions = ("approval_delay", "approval_duration",

923

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

483

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

924

484

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

925

485

"last_approval_request", "last_checked_ok",

926

486

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

935

495

"approved_by_default": "True",

936

496

"enabled": "True",

937

497

}

938

498

939

499

@staticmethod

940

500

def config_parser(config):

941

501

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

948

508

for client_name in config.sections():

949

509

section = dict(config.items(client_name))

950

510

client = settings[client_name] = {}

951

511

952

512

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

953

513

# Reformat values from string types to Python types

954

514

client["approved_by_default"] = config.getboolean(

955

515

client_name, "approved_by_default")

956

516

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

957

517

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

518

519

# Uppercase and remove spaces from fingerprint for later

520

# comparison purposes with return value from the

521

# fingerprint() function

964

522

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

965

523

.replace(" ", ""))

966

524

if "secret" in section:

967

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

968

.encode("utf-8"),

969

"base64")

525

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

970

526

elif "secfile" in section:

971

527

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

972

528

(section["secfile"])),

987

543

client["last_approval_request"] = None

988

544

client["last_checked_ok"] = None

989

545

client["last_checker_status"] = -2

990

546

991

547

return settings

992

993

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

548

549

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

994

550

self.name = name

995

551

if server_settings is None:

996

552

server_settings = {}

998

554

# adding all client settings

999

555

for setting, value in settings.items():

1000

556

setattr(self, setting, value)

1001

557

1002

558

if self.enabled:

1003

559

if not hasattr(self, "last_enabled"):

1004

560

self.last_enabled = datetime.datetime.utcnow()

1008

564

else:

1009

565

self.last_enabled = None

1010

566

self.expires = None

1011

1012

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

1013

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

1014

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

567

568

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

569

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

1015

570

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

1016

571

datetime.datetime.utcnow())

1017

572

1018

573

# attributes specific for this server instance

1019

574

self.checker = None

1020

575

self.checker_initiator_tag = None

1026

581

self.changedstate = multiprocessing_manager.Condition(

1027

582

multiprocessing_manager.Lock())

1028

583

self.client_structure = [attr

1029

for attr in self.__dict__.keys()

584

for attr in self.__dict__.iterkeys()

1030

585

if not attr.startswith("_")]

1031

586

self.client_structure.append("client_structure")

1032

587

1033

588

for name, t in inspect.getmembers(

1034

589

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

1035

590

if not name.startswith("_"):

1036

591

self.client_structure.append(name)

1037

592

1038

593

# Send notice to process children that client state has changed

1039

594

def send_changedstate(self):

1040

595

with self.changedstate:

1041

596

self.changedstate.notify_all()

1042

597

1043

598

def enable(self):

1044

599

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

1045

600

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

1050

605

self.last_enabled = datetime.datetime.utcnow()

1051

606

self.init_checker()

1052

607

self.send_changedstate()

1053

608

1054

609

def disable(self, quiet=True):

1055

610

"""Disable this client."""

1056

611

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

1057

612

return False

1058

613

if not quiet:

1059

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

614

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

1060

615

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

1061

GLib.source_remove(self.disable_initiator_tag)

616

gobject.source_remove(self.disable_initiator_tag)

1062

617

self.disable_initiator_tag = None

1063

618

self.expires = None

1064

619

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

1065

GLib.source_remove(self.checker_initiator_tag)

620

gobject.source_remove(self.checker_initiator_tag)

1066

621

self.checker_initiator_tag = None

1067

622

self.stop_checker()

1068

623

self.enabled = False

1069

624

if not quiet:

1070

625

self.send_changedstate()

1071

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

626

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

1072

627

return False

1073

628

1074

629

def __del__(self):

1075

630

self.disable()

1076

631

1077

632

def init_checker(self):

1078

633

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

1079

634

# and every interval from then on.

1080

635

if self.checker_initiator_tag is not None:

1081

GLib.source_remove(self.checker_initiator_tag)

1082

self.checker_initiator_tag = GLib.timeout_add(

1083

random.randrange(int(self.interval.total_seconds() * 1000

1084

+ 1)),

636

gobject.source_remove(self.checker_initiator_tag)

637

self.checker_initiator_tag = gobject.timeout_add(

638

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

1085

639

self.start_checker)

1086

640

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

1087

641

if self.disable_initiator_tag is not None:

1088

GLib.source_remove(self.disable_initiator_tag)

1089

self.disable_initiator_tag = GLib.timeout_add(

642

gobject.source_remove(self.disable_initiator_tag)

643

self.disable_initiator_tag = gobject.timeout_add(

1090

644

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

1091

645

# Also start a new checker *right now*.

1092

646

self.start_checker()

1093

1094

def checker_callback(self, source, condition, connection,

1095

command):

647

648

def checker_callback(self, source, condition,

649

(connection, command)):

1096

650

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

651

self.checker_callback_tag = None

652

self.checker = None

1097

653

# Read return code from connection (see call_pipe)

1098

654

returncode = connection.recv()

1099

655

connection.close()

1100

if self.checker is not None:

1101

self.checker.join()

1102

self.checker_callback_tag = None

1103

self.checker = None

1104

656

1105

657

if returncode >= 0:

1106

658

self.last_checker_status = returncode

1107

659

self.last_checker_signal = None

1108

660

if self.last_checker_status == 0:

1109

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

661

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

662

vars(self))

1110

663

self.checked_ok()

1111

664

else:

1112

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

665

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

1113

666

else:

1114

667

self.last_checker_status = -1

1115

668

self.last_checker_signal = -returncode

1116

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

669

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

670

vars(self))

1117

671

return False

1118

672

1119

673

def checked_ok(self):

1120

674

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

1121

675

self.last_checked_ok = datetime.datetime.utcnow()

1122

676

self.last_checker_status = 0

1123

677

self.last_checker_signal = None

1124

678

self.bump_timeout()

1125

679

1126

680

def bump_timeout(self, timeout=None):

1127

681

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

1128

682

if timeout is None:

1129

683

timeout = self.timeout

1130

684

if self.disable_initiator_tag is not None:

1131

GLib.source_remove(self.disable_initiator_tag)

685

gobject.source_remove(self.disable_initiator_tag)

1132

686

self.disable_initiator_tag = None

1133

687

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

1134

self.disable_initiator_tag = GLib.timeout_add(

688

self.disable_initiator_tag = gobject.timeout_add(

1135

689

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

1136

690

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

1137

691

1138

692

def need_approval(self):

1139

693

self.last_approval_request = datetime.datetime.utcnow()

1140

694

1141

695

def start_checker(self):

1142

696

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

1143

697

1144

698

If a checker already exists, leave it running and do

1145

699

nothing."""

1146

700

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

1151

705

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

1152

706

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

1153

707

# should be.

1154

708

1155

709

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

1156

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

710

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

1157

711

self.checker.join()

1158

712

self.checker = None

1159

713

# Start a new checker if needed

1160

714

if self.checker is None:

1161

715

# Escape attributes for the shell

1162

716

escaped_attrs = {

1163

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

1164

for attr in self.runtime_expansions}

717

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

718

for attr in self.runtime_expansions }

1165

719

try:

1166

720

command = self.checker_command % escaped_attrs

1167

721

except TypeError as error:

1168

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

1169

self.checker_command, exc_info=error)

722

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

723

self.checker_command,

724

exc_info=error)

1170

725

return True # Try again later

1171

726

self.current_checker_command = command

1172

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

727

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

728

self.name)

1173

729

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

1174

730

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

1175

731

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

1177

733

# The exception is when not debugging but nevertheless

1178

734

# running in the foreground; use the previously

1179

735

# created wnull.

1180

popen_args = {"close_fds": True,

1181

"shell": True,

1182

"cwd": "/"}

736

popen_args = { "close_fds": True,

737

"shell": True,

738

"cwd": "/" }

1183

739

if (not self.server_settings["debug"]

1184

740

and self.server_settings["foreground"]):

1185

741

popen_args.update({"stdout": wnull,

1186

"stderr": wnull})

742

"stderr": wnull })

1187

743

pipe = multiprocessing.Pipe(duplex=False)

1188

744

self.checker = multiprocessing.Process(

1189

target=call_pipe,

1190

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

1191

kwargs=popen_args)

745

target = call_pipe,

746

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

747

kwargs = popen_args)

1192

748

self.checker.start()

1193

self.checker_callback_tag = GLib.io_add_watch(

1194

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

1195

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1196

self.checker_callback, pipe[0], command)

1197

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

749

self.checker_callback_tag = gobject.io_add_watch(

750

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

751

self.checker_callback, (pipe[0], command))

752

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

1198

753

return True

1199

754

1200

755

def stop_checker(self):

1201

756

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

1202

757

if self.checker_callback_tag:

1203

GLib.source_remove(self.checker_callback_tag)

758

gobject.source_remove(self.checker_callback_tag)

1204

759

self.checker_callback_tag = None

1205

760

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

1206

761

return

1207

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

762

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

1208

763

self.checker.terminate()

1209

764

self.checker = None

1210

765

1215

770

byte_arrays=False):

1216

771

"""Decorators for marking methods of a DBusObjectWithProperties to

1217

772

become properties on the D-Bus.

1218

773

1219

774

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

1220

775

and with one argument by "Set".

1221

776

1222

777

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

1223

778

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

1224

779

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

1228

783

if byte_arrays and signature != "ay":

1229

784

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

1230

785

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

1231

786

1232

787

def decorator(func):

1233

788

func._dbus_is_property = True

1234

789

func._dbus_interface = dbus_interface

1237

792

func._dbus_name = func.__name__

1238

793

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

1239

794

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

1240

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

795

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1241

796

return func

1242

797

1243

798

return decorator

1244

799

1245

800

1246

801

def dbus_interface_annotations(dbus_interface):

1247

802

"""Decorator for marking functions returning interface annotations

1248

803

1249

804

Usage:

1250

805

1251

806

@dbus_interface_annotations("org.example.Interface")

1252

807

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

1253

808

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

1254

809

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

1255

810

"false"}

1256

811

"""

1257

812

1258

813

def decorator(func):

1259

814

func._dbus_is_interface = True

1260

815

func._dbus_interface = dbus_interface

1261

816

func._dbus_name = dbus_interface

1262

817

return func

1263

818

1264

819

return decorator

1265

820

1266

821

1267

822

def dbus_annotations(annotations):

1268

823

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

1269

824

Usage:

1270

825

1271

826

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

1272

827

"org.freedesktop.DBus.Property."

1273

828

"EmitsChangedSignal": "false"})

1275

830

access="r")

1276

831

def Property_dbus_property(self):

1277

832

return dbus.Boolean(False)

1278

1279

See also the DBusObjectWithAnnotations class.

1280

833

"""

1281

834

1282

835

def decorator(func):

1283

836

func._dbus_annotations = annotations

1284

837

return func

1285

838

1286

839

return decorator

1287

840

1288

841

1304

857

pass

1305

858

1306

859

1307

class DBusObjectWithAnnotations(dbus.service.Object):

1308

"""A D-Bus object with annotations.

1309

1310

Classes inheriting from this can use the dbus_annotations

1311

decorator to add annotations to methods or signals.

860

class DBusObjectWithProperties(dbus.service.Object):

861

"""A D-Bus object with properties.

862

863

Classes inheriting from this can use the dbus_service_property

864

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

865

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

1312

866

"""

1313

867

1314

868

@staticmethod

1315

869

def _is_dbus_thing(thing):

1316

870

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

1317

871

1318

872

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

1319

873

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

1320

874

"""

1321

875

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

1322

876

False)

1323

877

1324

878

def _get_all_dbus_things(self, thing):

1325

879

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

1326

880

"""

1329

883

for cls in self.__class__.__mro__

1330

884

for name, athing in

1331

885

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

1332

1333

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1334

out_signature="s",

1335

path_keyword="object_path",

1336

connection_keyword="connection")

1337

def Introspect(self, object_path, connection):

1338

"""Overloading of standard D-Bus method.

1339

1340

Inserts annotation tags on methods and signals.

1341

"""

1342

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

1343

connection)

1344

try:

1345

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

1346

1347

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

1348

# Add annotation tags

1349

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

1350

for tag in if_tag.getElementsByTagName(typ):

1351

annots = dict()

1352

for name, prop in (self.

1353

_get_all_dbus_things(typ)):

1354

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

1355

and prop._dbus_interface

1356

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

1357

annots.update(getattr(

1358

prop, "_dbus_annotations", {}))

1359

for name, value in annots.items():

1360

ann_tag = document.createElement(

1361

"annotation")

1362

ann_tag.setAttribute("name", name)

1363

ann_tag.setAttribute("value", value)

1364

tag.appendChild(ann_tag)

1365

# Add interface annotation tags

1366

for annotation, value in dict(

1367

itertools.chain.from_iterable(

1368

annotations().items()

1369

for name, annotations

1370

in self._get_all_dbus_things("interface")

1371

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

1372

)).items():

1373

ann_tag = document.createElement("annotation")

1374

ann_tag.setAttribute("name", annotation)

1375

ann_tag.setAttribute("value", value)

1376

if_tag.appendChild(ann_tag)

1377

# Fix argument name for the Introspect method itself

1378

if (if_tag.getAttribute("name")

1379

== dbus.INTROSPECTABLE_IFACE):

1380

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

1381

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

1382

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

1383

if (arg.getAttribute("direction")

1384

== "out"):

1385

arg.setAttribute("name",

1386

"xml_data")

1387

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

1388

document.unlink()

1389

except (AttributeError, xml.dom.DOMException,

1390

xml.parsers.expat.ExpatError) as error:

1391

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

1392

exc_info=error)

1393

return xmlstring

1394

1395

1396

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1397

"""A D-Bus object with properties.

1398

1399

Classes inheriting from this can use the dbus_service_property

1400

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

1401

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

1402

"""

1403

886

1404

887

def _get_dbus_property(self, interface_name, property_name):

1405

888

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

1406

889

property with the specified name and interface.

1411

894

if (value._dbus_name == property_name

1412

895

and value._dbus_interface == interface_name):

1413

896

return value.__get__(self)

1414

897

1415

898

# No such property

1416

899

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

1417

900

self.dbus_object_path, interface_name, property_name))

1418

1419

@classmethod

1420

def _get_all_interface_names(cls):

1421

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

1422

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

1423

"_dbus_interface", None)

1424

for x in (inspect.getmro(cls))

1425

for attr in dir(x))

1426

if name is not None)

1427

901

1428

902

@dbus.service.method(dbus.PROPERTIES_IFACE,

1429

903

in_signature="ss",

1430

904

out_signature="v")

1438

912

if not hasattr(value, "variant_level"):

1439

913

return value

1440

914

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

1441

915

1442

916

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

1443

917

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

1444

918

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

1453

927

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

1454

928

"'ay' signature {!r}"

1455

929

.format(prop._dbus_signature))

1456

value = dbus.ByteArray(bytes(value))

930

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

931

for byte in value))

1457

932

prop(value)

1458

933

1459

934

@dbus.service.method(dbus.PROPERTIES_IFACE,

1460

935

in_signature="s",

1461

936

out_signature="a{sv}")

1462

937

def GetAll(self, interface_name):

1463

938

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

1464

939

standard.

1465

940

1466

941

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

1467

942

"""

1468

943

properties = {}

1479

954

properties[name] = value

1480

955

continue

1481

956

properties[name] = type(value)(

1482

value, variant_level=value.variant_level + 1)

957

value, variant_level = value.variant_level + 1)

1483

958

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

1484

959

1485

960

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

1486

961

def PropertiesChanged(self, interface_name, changed_properties,

1487

962

invalidated_properties):

1489

964

standard.

1490

965

"""

1491

966

pass

1492

967

1493

968

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1494

969

out_signature="s",

1495

path_keyword="object_path",

1496

connection_keyword="connection")

970

path_keyword='object_path',

971

connection_keyword='connection')

1497

972

def Introspect(self, object_path, connection):

1498

973

"""Overloading of standard D-Bus method.

1499

974

1500

975

Inserts property tags and interface annotation tags.

1501

976

"""

1502

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1503

object_path,

1504

connection)

977

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

978

connection)

1505

979

try:

1506

980

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

1507

981

1508

982

def make_tag(document, name, prop):

1509

983

e = document.createElement("property")

1510

984

e.setAttribute("name", name)

1511

985

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

1512

986

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

1513

987

return e

1514

988

1515

989

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

1516

990

# Add property tags

1517

991

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

1520

994

if prop._dbus_interface

1521

995

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

1522

996

if_tag.appendChild(tag)

1523

# Add annotation tags for properties

1524

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

1525

annots = dict()

1526

for name, prop in self._get_all_dbus_things(

1527

"property"):

1528

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

1529

and prop._dbus_interface

1530

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

1531

annots.update(getattr(

1532

prop, "_dbus_annotations", {}))

1533

for name, value in annots.items():

1534

ann_tag = document.createElement(

1535

"annotation")

1536

ann_tag.setAttribute("name", name)

1537

ann_tag.setAttribute("value", value)

1538

tag.appendChild(ann_tag)

997

# Add annotation tags

998

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

999

for tag in if_tag.getElementsByTagName(typ):

1000

annots = dict()

1001

for name, prop in (self.

1002

_get_all_dbus_things(typ)):

1003

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

1004

and prop._dbus_interface

1005

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

1006

annots.update(getattr(

1007

prop, "_dbus_annotations", {}))

1008

for name, value in annots.items():

1009

ann_tag = document.createElement(

1010

"annotation")

1011

ann_tag.setAttribute("name", name)

1012

ann_tag.setAttribute("value", value)

1013

tag.appendChild(ann_tag)

1014

# Add interface annotation tags

1015

for annotation, value in dict(

1016

itertools.chain.from_iterable(

1017

annotations().items()

1018

for name, annotations

1019

in self._get_all_dbus_things("interface")

1020

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

1021

)).items():

1022

ann_tag = document.createElement("annotation")

1023

ann_tag.setAttribute("name", annotation)

1024

ann_tag.setAttribute("value", value)

1025

if_tag.appendChild(ann_tag)

1539

1026

# Add the names to the return values for the

1540

1027

# "org.freedesktop.DBus.Properties" methods

1541

1028

if (if_tag.getAttribute("name")

1555

1042

document.unlink()

1556

1043

except (AttributeError, xml.dom.DOMException,

1557

1044

xml.parsers.expat.ExpatError) as error:

1558

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

1559

exc_info=error)

1560

return xmlstring

1561

1562

1563

try:

1564

dbus.OBJECT_MANAGER_IFACE

1565

except AttributeError:

1566

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

1567

1568

1569

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1570

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

1571

1572

Classes inheriting from this exposes the standard

1573

GetManagedObjects call and the InterfacesAdded and

1574

InterfacesRemoved signals on the standard

1575

"org.freedesktop.DBus.ObjectManager" interface.

1576

1577

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

1578

manually.

1579

"""

1580

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1581

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

1582

def GetManagedObjects(self):

1583

"""This function must be overridden"""

1584

raise NotImplementedError()

1585

1586

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1587

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

1588

def InterfacesAdded(self, object_path, interfaces_and_properties):

1589

pass

1590

1591

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

1592

def InterfacesRemoved(self, object_path, interfaces):

1593

pass

1594

1595

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1596

out_signature="s",

1597

path_keyword="object_path",

1598

connection_keyword="connection")

1599

def Introspect(self, object_path, connection):

1600

"""Overloading of standard D-Bus method.

1601

1602

Override return argument name of GetManagedObjects to be

1603

"objpath_interfaces_and_properties"

1604

"""

1605

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1606

object_path,

1607

connection)

1608

try:

1609

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

1610

1611

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

1612

# Fix argument name for the GetManagedObjects method

1613

if (if_tag.getAttribute("name")

1614

== dbus.OBJECT_MANAGER_IFACE):

1615

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

1616

if (cn.getAttribute("name")

1617

== "GetManagedObjects"):

1618

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

1619

if (arg.getAttribute("direction")

1620

== "out"):

1621

arg.setAttribute(

1622

"name",

1623

"objpath_interfaces"

1624

"_and_properties")

1625

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

1626

document.unlink()

1627

except (AttributeError, xml.dom.DOMException,

1628

xml.parsers.expat.ExpatError) as error:

1629

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

1630

exc_info=error)

1045

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

1046

exc_info=error)

1631

1047

return xmlstring

1632

1048

1633

1049

1634

1050

def datetime_to_dbus(dt, variant_level=0):

1635

1051

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

1636

1052

if dt is None:

1637

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

1053

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

1638

1054

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

1639

1055

1640

1056

1643

1059

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

1644

1060

interface names according to the "alt_interface_names" mapping.

1645

1061

Usage:

1646

1062

1647

1063

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

1648

1064

"net.example.AlternateInterface"})

1649

1065

class SampleDBusObject(dbus.service.Object):

1650

1066

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

1651

1067

def SampleDBusMethod():

1652

1068

pass

1653

1069

1654

1070

The above "SampleDBusMethod" on "SampleDBusObject" will be

1655

1071

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

1656

1072

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

1657

1073

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

1658

1074

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

1659

1075

1660

1076

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

1661

1077

(from DBusObjectWithProperties) and interfaces (from the

1662

1078

dbus_interface_annotations decorator).

1663

1079

"""

1664

1080

1665

1081

def wrapper(cls):

1666

1082

for orig_interface_name, alt_interface_name in (

1667

1083

alt_interface_names.items()):

1684

1100

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

1685

1101

# Extract the original non-method undecorated

1686

1102

# function by black magic

1687

if sys.version_info.major == 2:

1688

nonmethod_func = (dict(

1689

zip(attribute.func_code.co_freevars,

1690

attribute.__closure__))

1691

["func"].cell_contents)

1692

else:

1693

nonmethod_func = (dict(

1694

zip(attribute.__code__.co_freevars,

1695

attribute.__closure__))

1696

["func"].cell_contents)

1103

nonmethod_func = (dict(

1104

zip(attribute.func_code.co_freevars,

1105

attribute.__closure__))

1106

["func"].cell_contents)

1697

1107

# Create a new, but exactly alike, function

1698

1108

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

1699

1109

# with the alternate D-Bus interface name

1700

new_function = copy_function(nonmethod_func)

1701

1110

new_function = (dbus.service.signal(

1702

alt_interface,

1703

attribute._dbus_signature)(new_function))

1111

alt_interface, attribute._dbus_signature)

1112

(types.FunctionType(

1113

nonmethod_func.func_code,

1114

nonmethod_func.func_globals,

1115

nonmethod_func.func_name,

1116

nonmethod_func.func_defaults,

1117

nonmethod_func.func_closure)))

1704

1118

# Copy annotations, if any

1705

1119

try:

1706

1120

new_function._dbus_annotations = dict(

1707

1121

attribute._dbus_annotations)

1708

1122

except AttributeError:

1709

1123

pass

1710

1711

1124

# Define a creator of a function to call both the

1712

1125

# original and alternate functions, so both the

1713

1126

# original and alternate signals gets sent when

1716

1129

"""This function is a scope container to pass

1717

1130

func1 and func2 to the "call_both" function

1718

1131

outside of its arguments"""

1719

1720

@functools.wraps(func2)

1132

1721

1133

def call_both(*args, **kwargs):

1722

1134

"""This function will emit two D-Bus

1723

1135

signals by calling func1 and func2"""

1724

1136

func1(*args, **kwargs)

1725

1137

func2(*args, **kwargs)

1726

# Make wrapper function look like a D-Bus

1727

# signal

1728

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

1729

if name.startswith("_dbus_"):

1730

setattr(call_both, name, attr)

1731

1138

1732

1139

return call_both

1733

1140

# Create the "call_both" function and add it to

1734

1141

# the class

1744

1151

alt_interface,

1745

1152

attribute._dbus_in_signature,

1746

1153

attribute._dbus_out_signature)

1747

(copy_function(attribute)))

1154

(types.FunctionType(attribute.func_code,

1155

attribute.func_globals,

1156

attribute.func_name,

1157

attribute.func_defaults,

1158

attribute.func_closure)))

1748

1159

# Copy annotations, if any

1749

1160

try:

1750

1161

attr[attrname]._dbus_annotations = dict(

1762

1173

attribute._dbus_access,

1763

1174

attribute._dbus_get_args_options

1764

1175

["byte_arrays"])

1765

(copy_function(attribute)))

1176

(types.FunctionType(

1177

attribute.func_code,

1178

attribute.func_globals,

1179

attribute.func_name,

1180

attribute.func_defaults,

1181

attribute.func_closure)))

1766

1182

# Copy annotations, if any

1767

1183

try:

1768

1184

attr[attrname]._dbus_annotations = dict(

1777

1193

# to the class.

1778

1194

attr[attrname] = (

1779

1195

dbus_interface_annotations(alt_interface)

1780

(copy_function(attribute)))

1196

(types.FunctionType(attribute.func_code,

1197

attribute.func_globals,

1198

attribute.func_name,

1199

attribute.func_defaults,

1200

attribute.func_closure)))

1781

1201

if deprecate:

1782

1202

# Deprecate all alternate interfaces

1783

iname = "_AlternateDBusNames_interface_annotation{}"

1203

iname="_AlternateDBusNames_interface_annotation{}"

1784

1204

for interface_name in interface_names:

1785

1205

1786

1206

@dbus_interface_annotations(interface_name)

1787

1207

def func(self):

1788

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

1789

"true"}

1208

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

1209

"true" }

1790

1210

# Find an unused name

1791

1211

for aname in (iname.format(i)

1792

1212

for i in itertools.count()):

1796

1216

if interface_names:

1797

1217

# Replace the class with a new subclass of it with

1798

1218

# methods, signals, etc. as created above.

1799

if sys.version_info.major == 2:

1800

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

1801

(cls, ), attr)

1802

else:

1803

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

1804

(cls, ), attr)

1219

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

1220

(cls, ), attr)

1805

1221

return cls

1806

1222

1807

1223

return wrapper

1808

1224

1809

1225

1811

1227

"se.bsnet.fukt.Mandos"})

1812

1228

class ClientDBus(Client, DBusObjectWithProperties):

1813

1229

"""A Client class using D-Bus

1814

1230

1815

1231

Attributes:

1816

1232

dbus_object_path: dbus.ObjectPath

1817

1233

bus: dbus.SystemBus()

1818

1234

"""

1819

1235

1820

1236

runtime_expansions = (Client.runtime_expansions

1821

1237

+ ("dbus_object_path", ))

1822

1238

1823

1239

_interface = "se.recompile.Mandos.Client"

1824

1240

1825

1241

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

1826

1827

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

1242

1243

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

1828

1244

self.bus = bus

1829

1245

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

1830

1246

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

1836

1252

"/clients/" + client_object_name)

1837

1253

DBusObjectWithProperties.__init__(self, self.bus,

1838

1254

self.dbus_object_path)

1839

1255

1840

1256

def notifychangeproperty(transform_func, dbus_name,

1841

1257

type_func=lambda x: x,

1842

1258

variant_level=1,

1844

1260

_interface=_interface):

1845

1261

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

1846

1262

its changes to DBus.

1847

1263

1848

1264

transform_fun: Function that takes a value and a variant_level

1849

1265

and transforms it to a D-Bus type.

1850

1266

dbus_name: D-Bus name of the variable

1853

1269

variant_level: D-Bus variant level. Default: 1

1854

1270

"""

1855

1271

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

1856

1272

1857

1273

def setter(self, value):

1858

1274

if hasattr(self, "dbus_object_path"):

1859

1275

if (not hasattr(self, attrname) or

1866

1282

else:

1867

1283

dbus_value = transform_func(

1868

1284

type_func(value),

1869

variant_level=variant_level)

1285

variant_level = variant_level)

1870

1286

self.PropertyChanged(dbus.String(dbus_name),

1871

1287

dbus_value)

1872

1288

self.PropertiesChanged(

1873

1289

_interface,

1874

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

1875

dbus_value}),

1290

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

1291

dbus_value }),

1876

1292

dbus.Array())

1877

1293

setattr(self, attrname, value)

1878

1294

1879

1295

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

1880

1296

1881

1297

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1882

1298

approvals_pending = notifychangeproperty(dbus.Boolean,

1883

1299

"ApprovalPending",

1884

type_func=bool)

1300

type_func = bool)

1885

1301

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

1886

1302

last_enabled = notifychangeproperty(datetime_to_dbus,

1887

1303

"LastEnabled")

1888

1304

checker = notifychangeproperty(

1889

1305

dbus.Boolean, "CheckerRunning",

1890

type_func=lambda checker: checker is not None)

1306

type_func = lambda checker: checker is not None)

1891

1307

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1892

1308

"LastCheckedOK")

1893

1309

last_checker_status = notifychangeproperty(dbus.Int16,

1898

1314

"ApprovedByDefault")

1899

1315

approval_delay = notifychangeproperty(

1900

1316

dbus.UInt64, "ApprovalDelay",

1901

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

1317

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

1902

1318

approval_duration = notifychangeproperty(

1903

1319

dbus.UInt64, "ApprovalDuration",

1904

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

1320

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

1905

1321

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

1906

1322

timeout = notifychangeproperty(

1907

1323

dbus.UInt64, "Timeout",

1908

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

1324

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

1909

1325

extended_timeout = notifychangeproperty(

1910

1326

dbus.UInt64, "ExtendedTimeout",

1911

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

1327

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

1912

1328

interval = notifychangeproperty(

1913

1329

dbus.UInt64, "Interval",

1914

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

1330

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

1915

1331

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

1916

1332

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

1917

1333

invalidate_only=True)

1918

1334

1919

1335

del notifychangeproperty

1920

1336

1921

1337

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

1922

1338

try:

1923

1339

self.remove_from_connection()

1926

1342

if hasattr(DBusObjectWithProperties, "__del__"):

1927

1343

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

1928

1344

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

1929

1345

1930

1346

def checker_callback(self, source, condition,

1931

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

1347

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

1932

1348

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

1933

connection, command, *args,

1349

(connection, command), *args,

1934

1350

**kwargs)

1935

1351

exitstatus = self.last_checker_status

1936

1352

if exitstatus >= 0:

1937

1353

# Emit D-Bus signal

1938

1354

self.CheckerCompleted(dbus.Int16(exitstatus),

1939

# This is specific to GNU libC

1940

dbus.Int64(exitstatus << 8),

1355

dbus.Int64(0),

1941

1356

dbus.String(command))

1942

1357

else:

1943

1358

# Emit D-Bus signal

1944

1359

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

1945

1360

dbus.Int64(

1946

# This is specific to GNU libC

1947

(exitstatus << 8)

1948

| self.last_checker_signal),

1361

self.last_checker_signal),

1949

1362

dbus.String(command))

1950

1363

return ret

1951

1364

1952

1365

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

1953

1366

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

1954

1367

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

1958

1371

# Emit D-Bus signal

1959

1372

self.CheckerStarted(self.current_checker_command)

1960

1373

return r

1961

1374

1962

1375

def _reset_approved(self):

1963

1376

self.approved = None

1964

1377

return False

1965

1378

1966

1379

def approve(self, value=True):

1967

1380

self.approved = value

1968

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

1969

* 1000), self._reset_approved)

1381

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

1382

* 1000), self._reset_approved)

1970

1383

self.send_changedstate()

1971

1972

# D-Bus methods, signals & properties

1973

1974

# Interfaces

1975

1976

# Signals

1977

1384

1385

## D-Bus methods, signals & properties

1386

1387

## Interfaces

1388

1389

## Signals

1390

1978

1391

# CheckerCompleted - signal

1979

1392

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

1980

1393

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

1981

1394

"D-Bus signal"

1982

1395

pass

1983

1396

1984

1397

# CheckerStarted - signal

1985

1398

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

1986

1399

def CheckerStarted(self, command):

1987

1400

"D-Bus signal"

1988

1401

pass

1989

1402

1990

1403

# PropertyChanged - signal

1991

1404

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

1992

1405

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

1993

1406

def PropertyChanged(self, property, value):

1994

1407

"D-Bus signal"

1995

1408

pass

1996

1409

1997

1410

# GotSecret - signal

1998

1411

@dbus.service.signal(_interface)

1999

1412

def GotSecret(self):

2002

1415

server to mandos-client

2003

1416

"""

2004

1417

pass

2005

1418

2006

1419

# Rejected - signal

2007

1420

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

2008

1421

def Rejected(self, reason):

2009

1422

"D-Bus signal"

2010

1423

pass

2011

1424

2012

1425

# NeedApproval - signal

2013

1426

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

2014

1427

def NeedApproval(self, timeout, default):

2015

1428

"D-Bus signal"

2016

1429

return self.need_approval()

2017

2018

# Methods

2019

1430

1431

## Methods

1432

2020

1433

# Approve - method

2021

1434

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

2022

1435

def Approve(self, value):

2023

1436

self.approve(value)

2024

1437

2025

1438

# CheckedOK - method

2026

1439

@dbus.service.method(_interface)

2027

1440

def CheckedOK(self):

2028

1441

self.checked_ok()

2029

1442

2030

1443

# Enable - method

2031

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

2032

1444

@dbus.service.method(_interface)

2033

1445

def Enable(self):

2034

1446

"D-Bus method"

2035

1447

self.enable()

2036

1448

2037

1449

# StartChecker - method

2038

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

2039

1450

@dbus.service.method(_interface)

2040

1451

def StartChecker(self):

2041

1452

"D-Bus method"

2042

1453

self.start_checker()

2043

1454

2044

1455

# Disable - method

2045

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

2046

1456

@dbus.service.method(_interface)

2047

1457

def Disable(self):

2048

1458

"D-Bus method"

2049

1459

self.disable()

2050

1460

2051

1461

# StopChecker - method

2052

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

2053

1462

@dbus.service.method(_interface)

2054

1463

def StopChecker(self):

2055

1464

self.stop_checker()

2056

2057

# Properties

2058

1465

1466

## Properties

1467

2059

1468

# ApprovalPending - property

2060

1469

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

2061

1470

def ApprovalPending_dbus_property(self):

2062

1471

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

2063

1472

2064

1473

# ApprovedByDefault - property

2065

1474

@dbus_service_property(_interface,

2066

1475

signature="b",

2069

1478

if value is None: # get

2070

1479

return dbus.Boolean(self.approved_by_default)

2071

1480

self.approved_by_default = bool(value)

2072

1481

2073

1482

# ApprovalDelay - property

2074

1483

@dbus_service_property(_interface,

2075

1484

signature="t",

2079

1488

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

2080

1489

* 1000)

2081

1490

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

2082

1491

2083

1492

# ApprovalDuration - property

2084

1493

@dbus_service_property(_interface,

2085

1494

signature="t",

2089

1498

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

2090

1499

* 1000)

2091

1500

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

2092

1501

2093

1502

# Name - property

2094

@dbus_annotations(

2095

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

2096

1503

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

2097

1504

def Name_dbus_property(self):

2098

1505

return dbus.String(self.name)

2099

2100

# KeyID - property

2101

@dbus_annotations(

2102

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

2103

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

2104

def KeyID_dbus_property(self):

2105

return dbus.String(self.key_id)

2106

1506

2107

1507

# Fingerprint - property

2108

@dbus_annotations(

2109

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

2110

1508

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

2111

1509

def Fingerprint_dbus_property(self):

2112

1510

return dbus.String(self.fingerprint)

2113

1511

2114

1512

# Host - property

2115

1513

@dbus_service_property(_interface,

2116

1514

signature="s",

2119

1517

if value is None: # get

2120

1518

return dbus.String(self.host)

2121

1519

self.host = str(value)

2122

1520

2123

1521

# Created - property

2124

@dbus_annotations(

2125

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

2126

1522

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

2127

1523

def Created_dbus_property(self):

2128

1524

return datetime_to_dbus(self.created)

2129

1525

2130

1526

# LastEnabled - property

2131

1527

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

2132

1528

def LastEnabled_dbus_property(self):

2133

1529

return datetime_to_dbus(self.last_enabled)

2134

1530

2135

1531

# Enabled - property

2136

1532

@dbus_service_property(_interface,

2137

1533

signature="b",

2143

1539

self.enable()

2144

1540

else:

2145

1541

self.disable()

2146

1542

2147

1543

# LastCheckedOK - property

2148

1544

@dbus_service_property(_interface,

2149

1545

signature="s",

2153

1549

self.checked_ok()

2154

1550

return

2155

1551

return datetime_to_dbus(self.last_checked_ok)

2156

1552

2157

1553

# LastCheckerStatus - property

2158

1554

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

2159

1555

def LastCheckerStatus_dbus_property(self):

2160

1556

return dbus.Int16(self.last_checker_status)

2161

1557

2162

1558

# Expires - property

2163

1559

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

2164

1560

def Expires_dbus_property(self):

2165

1561

return datetime_to_dbus(self.expires)

2166

1562

2167

1563

# LastApprovalRequest - property

2168

1564

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

2169

1565

def LastApprovalRequest_dbus_property(self):

2170

1566

return datetime_to_dbus(self.last_approval_request)

2171

1567

2172

1568

# Timeout - property

2173

1569

@dbus_service_property(_interface,

2174

1570

signature="t",

2189

1585

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

2190

1586

is None):

2191

1587

return

2192

GLib.source_remove(self.disable_initiator_tag)

2193

self.disable_initiator_tag = GLib.timeout_add(

1588

gobject.source_remove(self.disable_initiator_tag)

1589

self.disable_initiator_tag = gobject.timeout_add(

2194

1590

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

2195

1591

self.disable)

2196

1592

2197

1593

# ExtendedTimeout - property

2198

1594

@dbus_service_property(_interface,

2199

1595

signature="t",

2203

1599

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

2204

1600

* 1000)

2205

1601

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

2206

1602

2207

1603

# Interval - property

2208

1604

@dbus_service_property(_interface,

2209

1605

signature="t",

2216

1612

return

2217

1613

if self.enabled:

2218

1614

# Reschedule checker run

2219

GLib.source_remove(self.checker_initiator_tag)

2220

self.checker_initiator_tag = GLib.timeout_add(

1615

gobject.source_remove(self.checker_initiator_tag)

1616

self.checker_initiator_tag = gobject.timeout_add(

2221

1617

value, self.start_checker)

2222

self.start_checker() # Start one now, too

2223

1618

self.start_checker() # Start one now, too

1619

2224

1620

# Checker - property

2225

1621

@dbus_service_property(_interface,

2226

1622

signature="s",

2229

1625

if value is None: # get

2230

1626

return dbus.String(self.checker_command)

2231

1627

self.checker_command = str(value)

2232

1628

2233

1629

# CheckerRunning - property

2234

1630

@dbus_service_property(_interface,

2235

1631

signature="b",

2241

1637

self.start_checker()

2242

1638

else:

2243

1639

self.stop_checker()

2244

1640

2245

1641

# ObjectPath - property

2246

@dbus_annotations(

2247

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

2248

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

2249

1642

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

2250

1643

def ObjectPath_dbus_property(self):

2251

return self.dbus_object_path # is already a dbus.ObjectPath

2252

1644

return self.dbus_object_path # is already a dbus.ObjectPath

1645

2253

1646

# Secret = property

2254

@dbus_annotations(

2255

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

2256

"invalidates"})

2257

1647

@dbus_service_property(_interface,

2258

1648

signature="ay",

2259

1649

access="write",

2260

1650

byte_arrays=True)

2261

1651

def Secret_dbus_property(self, value):

2262

1652

self.secret = bytes(value)

2263

1653

2264

1654

del _interface

2265

1655

2266

1656

2267

class ProxyClient:

2268

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

1657

class ProxyClient(object):

1658

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

2269

1659

self._pipe = child_pipe

2270

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

1660

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

2271

1661

if not self._pipe.recv():

2272

raise KeyError(key_id or fpr)

2273

1662

raise KeyError()

1663

2274

1664

def __getattribute__(self, name):

2275

if name == "_pipe":

1665

if name == '_pipe':

2276

1666

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

2277

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

1667

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

2278

1668

data = self._pipe.recv()

2279

if data[0] == "data":

1669

if data[0] == 'data':

2280

1670

return data[1]

2281

if data[0] == "function":

2282

1671

if data[0] == 'function':

1672

2283

1673

def func(*args, **kwargs):

2284

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

1674

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

2285

1675

return self._pipe.recv()[1]

2286

1676

2287

1677

return func

2288

1678

2289

1679

def __setattr__(self, name, value):

2290

if name == "_pipe":

1680

if name == '_pipe':

2291

1681

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

2292

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

1682

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

2293

1683

2294

1684

2295

1685

class ClientHandler(socketserver.BaseRequestHandler, object):

2296

1686

"""A class to handle client connections.

2297

1687

2298

1688

Instantiated once for each connection to handle it.

2299

1689

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

2300

1690

2301

1691

def handle(self):

2302

1692

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

2303

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

2304

str(self.client_address))

2305

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

2306

2307

session = gnutls.ClientSession(self.request)

2308

2309

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

2310

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

2311

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

2312

# "+DHE-DSS"))

1693

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

1694

str(self.client_address))

1695

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

1696

self.server.child_pipe.fileno())

1697

1698

session = gnutls.connection.ClientSession(

1699

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

1700

1701

# Note: gnutls.connection.X509Credentials is really a

1702

# generic GnuTLS certificate credentials object so long as

1703

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

1704

# here despite using OpenPGP certificates.

1705

1706

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

1707

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

1708

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

1709

# "+DHE-DSS"))

2313

1710

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

2314

1711

priority = self.server.gnutls_priority

2315

1712

if priority is None:

2316

1713

priority = "NORMAL"

2317

gnutls.priority_set_direct(session,

2318

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

2319

1714

gnutls.library.functions.gnutls_priority_set_direct(

1715

session._c_object, priority, None)

1716

2320

1717

# Start communication using the Mandos protocol

2321

1718

# Get protocol number

2322

1719

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

2323

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

1720

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

2324

1721

try:

2325

1722

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

2326

1723

raise RuntimeError(line)

2327

1724

except (ValueError, IndexError, RuntimeError) as error:

2328

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

1725

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

2329

1726

return

2330

1727

2331

1728

# Start GnuTLS connection

2332

1729

try:

2333

1730

session.handshake()

2334

except gnutls.Error as error:

2335

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

1731

except gnutls.errors.GNUTLSError as error:

1732

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

2336

1733

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

2337

1734

# established. Just abandon the request.

2338

1735

return

2339

log.debug("Handshake succeeded")

2340

1736

logger.debug("Handshake succeeded")

1737

2341

1738

approval_required = False

2342

1739

try:

2343

if gnutls.has_rawpk:

2344

fpr = b""

2345

try:

2346

key_id = self.key_id(

2347

self.peer_certificate(session))

2348

except (TypeError, gnutls.Error) as error:

2349

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

2350

return

2351

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

2352

key_id.decode("utf-8",

2353

errors="replace"))

2354

2355

else:

2356

key_id = b""

2357

try:

2358

fpr = self.fingerprint(

2359

self.peer_certificate(session))

2360

except (TypeError, gnutls.Error) as error:

2361

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

2362

return

2363

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

2364

2365

try:

2366

client = ProxyClient(child_pipe, key_id, fpr,

1740

try:

1741

fpr = self.fingerprint(

1742

self.peer_certificate(session))

1743

except (TypeError,

1744

gnutls.errors.GNUTLSError) as error:

1745

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

1746

return

1747

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

1748

1749

try:

1750

client = ProxyClient(child_pipe, fpr,

2367

1751

self.client_address)

2368

1752

except KeyError:

2369

1753

return

2370

1754

2371

1755

if client.approval_delay:

2372

1756

delay = client.approval_delay

2373

1757

client.approvals_pending += 1

2374

1758

approval_required = True

2375

1759

2376

1760

while True:

2377

1761

if not client.enabled:

2378

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

1762

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

1763

client.name)

2379

1764

if self.server.use_dbus:

2380

1765

# Emit D-Bus signal

2381

1766

client.Rejected("Disabled")

2382

1767

return

2383

1768

2384

1769

if client.approved or not client.approval_delay:

2385

# We are approved or approval is disabled

1770

#We are approved or approval is disabled

2386

1771

break

2387

1772

elif client.approved is None:

2388

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

2389

client.name)

1773

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

1774

client.name)

2390

1775

if self.server.use_dbus:

2391

1776

# Emit D-Bus signal

2392

1777

client.NeedApproval(

2393

1778

client.approval_delay.total_seconds()

2394

1779

* 1000, client.approved_by_default)

2395

1780

else:

2396

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

2397

client.name)

1781

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

1782

client.name)

2398

1783

if self.server.use_dbus:

2399

1784

# Emit D-Bus signal

2400

1785

client.Rejected("Denied")

2401

1786

return

2402

2403

# wait until timeout or approved

1787

1788

#wait until timeout or approved

2404

1789

time = datetime.datetime.now()

2405

1790

client.changedstate.acquire()

2406

1791

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

2408

1793

time2 = datetime.datetime.now()

2409

1794

if (time2 - time) >= delay:

2410

1795

if not client.approved_by_default:

2411

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

2412

" waiting for approval",

2413

client.name)

1796

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

1797

" waiting for approval",

1798

client.name)

2414

1799

if self.server.use_dbus:

2415

1800

# Emit D-Bus signal

2416

1801

client.Rejected("Approval timed out")

2419

1804

break

2420

1805

else:

2421

1806

delay -= time2 - time

2422

2423

try:

2424

session.send(client.secret)

2425

except gnutls.Error as error:

2426

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

2427

return

2428

2429

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

1807

1808

sent_size = 0

1809

while sent_size < len(client.secret):

1810

try:

1811

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

1812

except gnutls.errors.GNUTLSError as error:

1813

logger.warning("gnutls send failed",

1814

exc_info=error)

1815

return

1816

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

1817

len(client.secret) - (sent_size

1818

+ sent))

1819

sent_size += sent

1820

1821

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

2430

1822

# bump the timeout using extended_timeout

2431

1823

client.bump_timeout(client.extended_timeout)

2432

1824

if self.server.use_dbus:

2433

1825

# Emit D-Bus signal

2434

1826

client.GotSecret()

2435

1827

2436

1828

finally:

2437

1829

if approval_required:

2438

1830

client.approvals_pending -= 1

2439

1831

try:

2440

1832

session.bye()

2441

except gnutls.Error as error:

2442

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

2443

1833

except gnutls.errors.GNUTLSError as error:

1834

logger.warning("GnuTLS bye failed",

1835

exc_info=error)

1836

2444

1837

@staticmethod

2445

1838

def peer_certificate(session):

2446

"Return the peer's certificate as a bytestring"

2447

try:

2448

cert_type = gnutls.certificate_type_get2(

2449

session, gnutls.CTYPE_PEERS)

2450

except AttributeError:

2451

cert_type = gnutls.certificate_type_get(session)

2452

if gnutls.has_rawpk:

2453

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2454

else:

2455

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2456

# If not a valid certificate type...

2457

if cert_type not in valid_cert_types:

2458

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

2459

valid_cert_types)

2460

# ...return invalid data

2461

return b""

1839

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

1840

# If not an OpenPGP certificate...

1841

if (gnutls.library.functions.gnutls_certificate_type_get(

1842

session._c_object)

1843

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1844

# ...do the normal thing

1845

return session.peer_certificate

2462

1846

list_size = ctypes.c_uint(1)

2463

cert_list = (gnutls.certificate_get_peers

2464

(session, ctypes.byref(list_size)))

1847

cert_list = (gnutls.library.functions

1848

.gnutls_certificate_get_peers

1849

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

2465

1850

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

2466

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

1851

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

1852

" certificate")

2467

1853

if list_size.value == 0:

2468

1854

return None

2469

1855

cert = cert_list[0]

2470

1856

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

2471

2472

@staticmethod

2473

def key_id(certificate):

2474

"Convert a certificate bytestring to a hexdigit key ID"

2475

# New GnuTLS "datum" with the public key

2476

datum = gnutls.datum_t(

2477

ctypes.cast(ctypes.c_char_p(certificate),

2478

ctypes.POINTER(ctypes.c_ubyte)),

2479

ctypes.c_uint(len(certificate)))

2480

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

2481

# New empty GnuTLS certificate

2482

pubkey = gnutls.pubkey_t()

2483

gnutls.pubkey_init(ctypes.byref(pubkey))

2484

# Import the raw public key into the certificate

2485

gnutls.pubkey_import(pubkey,

2486

ctypes.byref(datum),

2487

gnutls.X509_FMT_DER)

2488

# New buffer for the key ID

2489

buf = ctypes.create_string_buffer(32)

2490

buf_len = ctypes.c_size_t(len(buf))

2491

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

2492

gnutls.pubkey_get_key_id(

2493

pubkey,

2494

gnutls.KEYID_USE_SHA256,

2495

ctypes.cast(ctypes.byref(buf),

2496

ctypes.POINTER(ctypes.c_ubyte)),

2497

ctypes.byref(buf_len))

2498

# Deinit the certificate

2499

gnutls.pubkey_deinit(pubkey)

2500

2501

# Convert the buffer to a Python bytestring

2502

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

2503

# Convert the bytestring to hexadecimal notation

2504

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

2505

return hex_key_id

2506

1857

2507

1858

@staticmethod

2508

1859

def fingerprint(openpgp):

2509

1860

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2510

1861

# New GnuTLS "datum" with the OpenPGP public key

2511

datum = gnutls.datum_t(

1862

datum = gnutls.library.types.gnutls_datum_t(

2512

1863

ctypes.cast(ctypes.c_char_p(openpgp),

2513

1864

ctypes.POINTER(ctypes.c_ubyte)),

2514

1865

ctypes.c_uint(len(openpgp)))

2515

1866

# New empty GnuTLS certificate

2516

crt = gnutls.openpgp_crt_t()

2517

gnutls.openpgp_crt_init(ctypes.byref(crt))

1867

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1868

gnutls.library.functions.gnutls_openpgp_crt_init(

1869

ctypes.byref(crt))

2518

1870

# Import the OpenPGP public key into the certificate

2519

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

2520

gnutls.OPENPGP_FMT_RAW)

1871

gnutls.library.functions.gnutls_openpgp_crt_import(

1872

crt, ctypes.byref(datum),

1873

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

2521

1874

# Verify the self signature in the key

2522

1875

crtverify = ctypes.c_uint()

2523

gnutls.openpgp_crt_verify_self(crt, 0,

2524

ctypes.byref(crtverify))

1876

gnutls.library.functions.gnutls_openpgp_crt_verify_self(

1877

crt, 0, ctypes.byref(crtverify))

2525

1878

if crtverify.value != 0:

2526

gnutls.openpgp_crt_deinit(crt)

2527

raise gnutls.CertificateSecurityError(code

2528

=crtverify.value)

1879

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1880

raise gnutls.errors.CertificateSecurityError(

1881

"Verify failed")

2529

1882

# New buffer for the fingerprint

2530

1883

buf = ctypes.create_string_buffer(20)

2531

1884

buf_len = ctypes.c_size_t()

2532

1885

# Get the fingerprint from the certificate into the buffer

2533

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

2534

ctypes.byref(buf_len))

1886

gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(

1887

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

2535

1888

# Deinit the certificate

2536

gnutls.openpgp_crt_deinit(crt)

1889

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2537

1890

# Convert the buffer to a Python bytestring

2538

1891

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

2539

1892

# Convert the bytestring to hexadecimal notation

2541

1894

return hex_fpr

2542

1895

2543

1896

2544

class MultiprocessingMixIn:

1897

class MultiprocessingMixIn(object):

2545

1898

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

2546

1899

2547

1900

def sub_process_main(self, request, address):

2548

1901

try:

2549

1902

self.finish_request(request, address)

2550

1903

except Exception:

2551

1904

self.handle_error(request, address)

2552

1905

self.close_request(request)

2553

1906

2554

1907

def process_request(self, request, address):

2555

1908

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

2556

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

2557

args=(request, address))

1909

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

1910

args = (request, address))

2558

1911

proc.start()

2559

1912

return proc

2560

1913

2561

1914

2562

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1915

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2563

1916

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

2564

1917

2565

1918

def process_request(self, request, client_address):

2566

1919

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

2567

1920

2568

1921

This function creates a new pipe in self.pipe

2569

1922

"""

2570

1923

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2571

1924

2572

1925

proc = MultiprocessingMixIn.process_request(self, request,

2573

1926

client_address)

2574

1927

self.child_pipe.close()

2575

1928

self.add_pipe(parent_pipe, proc)

2576

1929

2577

1930

def add_pipe(self, parent_pipe, proc):

2578

1931

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

2579

1932

raise NotImplementedError()

2580

1933

2581

1934

2582

1935

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2583

socketserver.TCPServer):

2584

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

2585

1936

socketserver.TCPServer, object):

1937

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

1938

2586

1939

Attributes:

2587

1940

enabled: Boolean; whether this server is activated yet

2588

1941

interface: None or a network interface name (string)

2589

1942

use_ipv6: Boolean; to use IPv6 or not

2590

1943

"""

2591

1944

2592

1945

def __init__(self, server_address, RequestHandlerClass,

2593

1946

interface=None,

2594

1947

use_ipv6=True,

2604

1957

self.socketfd = socketfd

2605

1958

# Save the original socket.socket() function

2606

1959

self.socket_socket = socket.socket

2607

2608

1960

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

2609

#

1961

#

2610

1962

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

2611

1963

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

2612

1964

# patching socket.socket.)

2613

#

1965

#

2614

1966

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

2615

1967

@functools.wraps(socket.socket)

2616

1968

def socket_wrapper(*args, **kwargs):

2628

1980

# socket_wrapper(), if socketfd was set.

2629

1981

socketserver.TCPServer.__init__(self, server_address,

2630

1982

RequestHandlerClass)

2631

1983

2632

1984

def server_bind(self):

2633

1985

"""This overrides the normal server_bind() function

2634

1986

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

2635

1987

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

2636

global SO_BINDTODEVICE

2637

1988

if self.interface is not None:

2638

1989

if SO_BINDTODEVICE is None:

2639

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

2640

# common enough.

2641

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

2642

SO_BINDTODEVICE = 25

2643

try:

2644

self.socket.setsockopt(

2645

socket.SOL_SOCKET, SO_BINDTODEVICE,

2646

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

2647

except socket.error as error:

2648

if error.errno == errno.EPERM:

2649

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

2650

self.interface)

2651

elif error.errno == errno.ENOPROTOOPT:

2652

log.error("SO_BINDTODEVICE not available; cannot"

2653

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

2654

elif error.errno == errno.ENODEV:

2655

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

2656

" bind", self.interface)

2657

else:

2658

raise

1990

logger.error("SO_BINDTODEVICE does not exist;"

1991

" cannot bind to interface %s",

1992

self.interface)

1993

else:

1994

try:

1995

self.socket.setsockopt(

1996

socket.SOL_SOCKET, SO_BINDTODEVICE,

1997

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

1998

except socket.error as error:

1999

if error.errno == errno.EPERM:

2000

logger.error("No permission to bind to"

2001

" interface %s", self.interface)

2002

elif error.errno == errno.ENOPROTOOPT:

2003

logger.error("SO_BINDTODEVICE not available;"

2004

" cannot bind to interface %s",

2005

self.interface)

2006

elif error.errno == errno.ENODEV:

2007

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

2008

" cannot bind", self.interface)

2009

else:

2010

raise

2659

2011

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

2660

2012

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

2661

if self.server_address[1]:

2662

self.allow_reuse_address = True

2663

2013

if not self.server_address[0]:

2664

2014

if self.address_family == socket.AF_INET6:

2665

any_address = "::" # in6addr_any

2015

any_address = "::" # in6addr_any

2666

2016

else:

2667

any_address = "0.0.0.0" # INADDR_ANY

2017

any_address = "0.0.0.0" # INADDR_ANY

2668

2018

self.server_address = (any_address,

2669

2019

self.server_address[1])

2670

2020

elif not self.server_address[1]:

2680

2030

2681

2031

class MandosServer(IPv6_TCPServer):

2682

2032

"""Mandos server.

2683

2033

2684

2034

Attributes:

2685

2035

clients: set of Client objects

2686

2036

gnutls_priority GnuTLS priority string

2687

2037

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

2688

2689

Assumes a GLib.MainLoop event loop.

2038

2039

Assumes a gobject.MainLoop event loop.

2690

2040

"""

2691

2041

2692

2042

def __init__(self, server_address, RequestHandlerClass,

2693

2043

interface=None,

2694

2044

use_ipv6=True,

2704

2054

self.gnutls_priority = gnutls_priority

2705

2055

IPv6_TCPServer.__init__(self, server_address,

2706

2056

RequestHandlerClass,

2707

interface=interface,

2708

use_ipv6=use_ipv6,

2709

socketfd=socketfd)

2710

2057

interface = interface,

2058

use_ipv6 = use_ipv6,

2059

socketfd = socketfd)

2060

2711

2061

def server_activate(self):

2712

2062

if self.enabled:

2713

2063

return socketserver.TCPServer.server_activate(self)

2714

2064

2715

2065

def enable(self):

2716

2066

self.enabled = True

2717

2067

2718

2068

def add_pipe(self, parent_pipe, proc):

2719

2069

# Call "handle_ipc" for both data and EOF events

2720

GLib.io_add_watch(

2721

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

2722

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

2070

gobject.io_add_watch(

2071

parent_pipe.fileno(),

2072

gobject.IO_IN | gobject.IO_HUP,

2723

2073

functools.partial(self.handle_ipc,

2724

parent_pipe=parent_pipe,

2725

proc=proc))

2726

2074

parent_pipe = parent_pipe,

2075

proc = proc))

2076

2727

2077

def handle_ipc(self, source, condition,

2728

2078

parent_pipe=None,

2729

proc=None,

2079

proc = None,

2730

2080

client_object=None):

2731

2081

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

2732

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

2082

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

2733

2083

# Wait for other process to exit

2734

2084

proc.join()

2735

2085

return False

2736

2086

2737

2087

# Read a request from the child

2738

2088

request = parent_pipe.recv()

2739

2089

command = request[0]

2740

2741

if command == "init":

2742

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

2743

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

2744

address = request[3]

2745

2746

for c in self.clients.values():

2747

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2748

"27AE41E4649B934CA495991B7852B855"):

2749

continue

2750

if key_id and c.key_id == key_id:

2751

client = c

2752

break

2753

if fpr and c.fingerprint == fpr:

2090

2091

if command == 'init':

2092

fpr = request[1]

2093

address = request[2]

2094

2095

for c in self.clients.itervalues():

2096

if c.fingerprint == fpr:

2754

2097

client = c

2755

2098

break

2756

2099

else:

2757

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

2758

" %s", key_id or fpr, address)

2100

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

2101

"dress: %s", fpr, address)

2759

2102

if self.use_dbus:

2760

2103

# Emit D-Bus signal

2761

mandos_dbus_service.ClientNotFound(key_id or fpr,

2104

mandos_dbus_service.ClientNotFound(fpr,

2762

2105

address[0])

2763

2106

parent_pipe.send(False)

2764

2107

return False

2765

2766

GLib.io_add_watch(

2767

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

2768

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

2108

2109

gobject.io_add_watch(

2110

parent_pipe.fileno(),

2111

gobject.IO_IN | gobject.IO_HUP,

2769

2112

functools.partial(self.handle_ipc,

2770

parent_pipe=parent_pipe,

2771

proc=proc,

2772

client_object=client))

2113

parent_pipe = parent_pipe,

2114

proc = proc,

2115

client_object = client))

2773

2116

parent_pipe.send(True)

2774

2117

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

2775

2118

# same fileno

2776

2119

return False

2777

if command == "funcall":

2120

if command == 'funcall':

2778

2121

funcname = request[1]

2779

2122

args = request[2]

2780

2123

kwargs = request[3]

2781

2782

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

2124

2125

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

2783

2126

funcname)(*args,

2784

2127

**kwargs)))

2785

2786

if command == "getattr":

2128

2129

if command == 'getattr':

2787

2130

attrname = request[1]

2788

if isinstance(client_object.__getattribute__(attrname),

2789

collections.abc.Callable):

2790

parent_pipe.send(("function", ))

2131

if callable(client_object.__getattribute__(attrname)):

2132

parent_pipe.send(('function', ))

2791

2133

else:

2792

2134

parent_pipe.send((

2793

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

2794

2795

if command == "setattr":

2135

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

2136

2137

if command == 'setattr':

2796

2138

attrname = request[1]

2797

2139

value = request[2]

2798

2140

setattr(client_object, attrname, value)

2799

2141

2800

2142

return True

2801

2143

2802

2144

2803

2145

def rfc3339_duration_to_delta(duration):

2804

2146

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

2805

2806

>>> timedelta = datetime.timedelta

2807

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

2808

True

2809

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

2810

True

2811

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

2812

True

2813

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

2814

True

2815

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

2816

True

2817

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

2818

True

2819

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

2820

True

2821

>>> del timedelta

2147

2148

>>> rfc3339_duration_to_delta("P7D")

2149

datetime.timedelta(7)

2150

>>> rfc3339_duration_to_delta("PT60S")

2151

datetime.timedelta(0, 60)

2152

>>> rfc3339_duration_to_delta("PT60M")

2153

datetime.timedelta(0, 3600)

2154

>>> rfc3339_duration_to_delta("PT24H")

2155

datetime.timedelta(1)

2156

>>> rfc3339_duration_to_delta("P1W")

2157

datetime.timedelta(7)

2158

>>> rfc3339_duration_to_delta("PT5M30S")

2159

datetime.timedelta(0, 330)

2160

>>> rfc3339_duration_to_delta("P1DT3M20S")

2161

datetime.timedelta(1, 200)

2822

2162

"""

2823

2163

2824

2164

# Parsing an RFC 3339 duration with regular expressions is not

2825

2165

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

2826

2166

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

2827

2167

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

2828

2168

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

2829

2169

# avoid excessive use of external libraries.

2830

2170

2831

2171

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

2172

Token = collections.namedtuple("Token",

2173

("regexp", # To match token; if

2174

# "value" is not None,

2175

# must have a "group"

2176

# containing digits

2177

"value", # datetime.timedelta or

2178

# None

2179

"followers")) # Tokens valid after

2180

# this token

2832

2181

Token = collections.namedtuple("Token", (

2833

2182

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

2834

2183

# a "group" containing digits

2866

2215

frozenset((token_year, token_month,

2867

2216

token_day, token_time,

2868

2217

token_week)))

2869

# Define starting values:

2870

# Value so far

2871

value = datetime.timedelta()

2218

# Define starting values

2219

value = datetime.timedelta() # Value so far

2872

2220

found_token = None

2873

# Following valid tokens

2874

followers = frozenset((token_duration, ))

2875

# String left to parse

2876

s = duration

2221

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

2222

s = duration # String left to parse

2877

2223

# Loop until end token is found

2878

2224

while found_token is not token_end:

2879

2225

# Search for any currently valid tokens

2895

2241

break

2896

2242

else:

2897

2243

# No currently valid tokens were found

2898

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

2899

.format(duration))

2244

raise ValueError("Invalid RFC 3339 duration")

2900

2245

# End token found

2901

2246

return value

2902

2247

2903

2248

2904

2249

def string_to_delta(interval):

2905

2250

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

2906

2907

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

2908

True

2909

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

2910

True

2911

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

2912

True

2913

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

2914

True

2915

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

2916

True

2917

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

2918

True

2251

2252

>>> string_to_delta('7d')

2253

datetime.timedelta(7)

2254

>>> string_to_delta('60s')

2255

datetime.timedelta(0, 60)

2256

>>> string_to_delta('60m')

2257

datetime.timedelta(0, 3600)

2258

>>> string_to_delta('24h')

2259

datetime.timedelta(1)

2260

>>> string_to_delta('1w')

2261

datetime.timedelta(7)

2262

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

2263

datetime.timedelta(0, 330)

2919

2264

"""

2920

2265

2921

2266

try:

2922

2267

return rfc3339_duration_to_delta(interval)

2923

2268

except ValueError:

2924

2269

pass

2925

2270

2926

2271

timevalue = datetime.timedelta(0)

2927

2272

for s in interval.split():

2928

2273

try:

2946

2291

return timevalue

2947

2292

2948

2293

2949

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

2294

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

2950

2295

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

2951

2296

2952

2297

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

2953

2298

if os.fork():

2954

2299

sys.exit()

2972

2317

2973

2318

2974

2319

def main():

2975

2320

2976

2321

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

2977

2322

# Parsing of options, both command line and config file

2978

2323

2979

2324

parser = argparse.ArgumentParser()

2980

2325

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

2981

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

2326

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

2982

2327

help="show version number and exit")

2983

2328

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

2984

2329

help="Bind to interface IF")

3020

2365

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

3021

2366

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

3022

2367

default=None)

3023

2368

3024

2369

options = parser.parse_args()

3025

2370

2371

if options.check:

2372

import doctest

2373

fail_count, test_count = doctest.testmod()

2374

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

2375

3026

2376

# Default values for config file for server-global settings

3027

if gnutls.has_rawpk:

3028

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

3029

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

3030

else:

3031

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

3032

":+SIGN-DSA-SHA256")

3033

server_defaults = {"interface": "",

3034

"address": "",

3035

"port": "",

3036

"debug": "False",

3037

"priority": priority,

3038

"servicename": "Mandos",

3039

"use_dbus": "True",

3040

"use_ipv6": "True",

3041

"debuglevel": "",

3042

"restore": "True",

3043

"socket": "",

3044

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

3045

"foreground": "False",

3046

"zeroconf": "True",

3047

}

3048

del priority

3049

2377

server_defaults = { "interface": "",

2378

"address": "",

2379

"port": "",

2380

"debug": "False",

2381

"priority":

2382

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

2383

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

2384

"servicename": "Mandos",

2385

"use_dbus": "True",

2386

"use_ipv6": "True",

2387

"debuglevel": "",

2388

"restore": "True",

2389

"socket": "",

2390

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

2391

"foreground": "False",

2392

"zeroconf": "True",

2393

}

2394

3050

2395

# Parse config file for server-global settings

3051

server_config = configparser.ConfigParser(server_defaults)

2396

server_config = configparser.SafeConfigParser(server_defaults)

3052

2397

del server_defaults

3053

2398

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

3054

# Convert the ConfigParser object to a dict

2399

# Convert the SafeConfigParser object to a dict

3055

2400

server_settings = server_config.defaults()

3056

2401

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

3057

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

3058

"foreground", "zeroconf"):

2402

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

3059

2403

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

3060

2404

option)

3061

2405

if server_settings["port"]:

3071

2415

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

3072

2416

["socket"])

3073

2417

del server_config

3074

2418

3075

2419

# Override the settings from the config file with command line

3076

2420

# options, if set.

3077

2421

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

3095

2439

if server_settings["debug"]:

3096

2440

server_settings["foreground"] = True

3097

2441

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

3098

2442

3099

2443

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

3100

2444

3101

2445

if (not server_settings["zeroconf"]

3102

2446

and not (server_settings["port"]

3103

2447

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

3104

2448

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

3105

2449

3106

2450

# For convenience

3107

2451

debug = server_settings["debug"]

3108

2452

debuglevel = server_settings["debuglevel"]

3112

2456

stored_state_file)

3113

2457

foreground = server_settings["foreground"]

3114

2458

zeroconf = server_settings["zeroconf"]

3115

2459

3116

2460

if debug:

3117

2461

initlogger(debug, logging.DEBUG)

3118

2462

else:

3121

2465

else:

3122

2466

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

3123

2467

initlogger(debug, level)

3124

2468

3125

2469

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

3126

2470

syslogger.setFormatter(

3127

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

3128

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

2471

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

2472

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

3129

2473

server_settings["servicename"])))

3130

2474

3131

2475

# Parse config file with clients

3132

client_config = configparser.ConfigParser(Client.client_defaults)

2476

client_config = configparser.SafeConfigParser(Client

2477

.client_defaults)

3133

2478

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

3134

2479

"clients.conf"))

3135

2480

3136

2481

global mandos_dbus_service

3137

2482

mandos_dbus_service = None

3138

2483

3139

2484

socketfd = None

3140

2485

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

3141

2486

socketfd = server_settings["socket"]

3153

2498

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

3154

2499

pidfile = None

3155

2500

try:

3156

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

2501

pidfile = open(pidfilename, "w")

3157

2502

except IOError as e:

3158

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

3159

exc_info=e)

3160

3161

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

3162

("mandos", "mandos"),

3163

("nobody", "nogroup")):

2503

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

2504

exc_info=e)

2505

2506

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

3164

2507

try:

3165

2508

uid = pwd.getpwnam(name).pw_uid

3166

gid = pwd.getpwnam(group).pw_gid

2509

gid = pwd.getpwnam(name).pw_gid

3167

2510

break

3168

2511

except KeyError:

3169

2512

continue

3173

2516

try:

3174

2517

os.setgid(gid)

3175

2518

os.setuid(uid)

3176

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

3177

2519

except OSError as error:

3178

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

3179

os.strerror(error.errno))

3180

2520

if error.errno != errno.EPERM:

3181

2521

raise

3182

2522

3183

2523

if debug:

3184

2524

# Enable all possible GnuTLS debugging

3185

2525

3186

2526

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

3187

2527

# - GnuTLS manual

3188

gnutls.global_set_log_level(11)

3189

3190

@gnutls.log_func

2528

gnutls.library.functions.gnutls_global_set_log_level(11)

2529

2530

@gnutls.library.types.gnutls_log_func

3191

2531

def debug_gnutls(level, string):

3192

log.debug("GnuTLS: %s",

3193

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

3194

3195

gnutls.global_set_log_function(debug_gnutls)

3196

2532

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

2533

2534

gnutls.library.functions.gnutls_global_set_log_function(

2535

debug_gnutls)

2536

3197

2537

# Redirect stdin so all checkers get /dev/null

3198

2538

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

3199

2539

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

3200

2540

if null > 2:

3201

2541

os.close(null)

3202

2542

3203

2543

# Need to fork before connecting to D-Bus

3204

2544

if not foreground:

3205

2545

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

3206

2546

daemon()

3207

3208

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

3209

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

3210

# need to inform GLib that threads will be used.

3211

GLib.threads_init()

3212

2547

2548

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

2549

# need to inform gobject that threads will be used.

2550

gobject.threads_init()

2551

3213

2552

global main_loop

3214

2553

# From the Avahi example code

3215

2554

DBusGMainLoop(set_as_default=True)

3216

main_loop = GLib.MainLoop()

2555

main_loop = gobject.MainLoop()

3217

2556

bus = dbus.SystemBus()

3218

2557

# End of Avahi example code

3219

2558

if use_dbus:

3224

2563

old_bus_name = dbus.service.BusName(

3225

2564

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

3226

2565

do_not_queue=True)

3227

except dbus.exceptions.DBusException as e:

3228

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

2566

except dbus.exceptions.NameExistsException as e:

2567

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

3229

2568

use_dbus = False

3230

2569

server_settings["use_dbus"] = False

3231

2570

tcp_server.use_dbus = False

3232

2571

if zeroconf:

3233

2572

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3234

2573

service = AvahiServiceToSyslog(

3235

name=server_settings["servicename"],

3236

servicetype="_mandos._tcp",

3237

protocol=protocol,

3238

bus=bus)

2574

name = server_settings["servicename"],

2575

servicetype = "_mandos._tcp",

2576

protocol = protocol,

2577

bus = bus)

3239

2578

if server_settings["interface"]:

3240

2579

service.interface = if_nametoindex(

3241

2580

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

3242

2581

3243

2582

global multiprocessing_manager

3244

2583

multiprocessing_manager = multiprocessing.Manager()

3245

2584

3246

2585

client_class = Client

3247

2586

if use_dbus:

3248

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

3249

2587

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

2588

3250

2589

client_settings = Client.config_parser(client_config)

3251

2590

old_client_settings = {}

3252

2591

clients_data = {}

3253

2592

3254

2593

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

3255

2594

global wnull

3256

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

2595

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

3257

2596

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

3258

2597

# mode

3259

2598

if debug or not foreground:

3260

2599

wnull.close()

3261

2600

3262

2601

# Get client data and settings from last running state.

3263

2602

if server_settings["restore"]:

3264

2603

try:

3265

2604

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

3266

if sys.version_info.major == 2:

3267

clients_data, old_client_settings = pickle.load(

3268

stored_state)

3269

else:

3270

bytes_clients_data, bytes_old_client_settings = (

3271

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

3272

# Fix bytes to strings

3273

# clients_data

3274

# .keys()

3275

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

3276

if isinstance(key, bytes)

3277

else key): value

3278

for key, value in

3279

bytes_clients_data.items()}

3280

del bytes_clients_data

3281

for key in clients_data:

3282

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

3283

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

3284

for k, v in

3285

clients_data[key].items()}

3286

clients_data[key] = value

3287

# .client_structure

3288

value["client_structure"] = [

3289

(s.decode("utf-8")

3290

if isinstance(s, bytes)

3291

else s) for s in

3292

value["client_structure"]]

3293

# .name, .host, and .checker_command

3294

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

3295

if isinstance(value[k], bytes):

3296

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

3297

if "key_id" not in value:

3298

value["key_id"] = ""

3299

elif "fingerprint" not in value:

3300

value["fingerprint"] = ""

3301

# old_client_settings

3302

# .keys()

3303

old_client_settings = {

3304

(key.decode("utf-8")

3305

if isinstance(key, bytes)

3306

else key): value

3307

for key, value in

3308

bytes_old_client_settings.items()}

3309

del bytes_old_client_settings

3310

# .host and .checker_command

3311

for value in old_client_settings.values():

3312

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

3313

if isinstance(value[attribute], bytes):

3314

value[attribute] = (value[attribute]

3315

.decode("utf-8"))

2605

clients_data, old_client_settings = pickle.load(

2606

stored_state)

3316

2607

os.remove(stored_state_path)

3317

2608

except IOError as e:

3318

2609

if e.errno == errno.ENOENT:

3319

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

3320

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

2610

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

2611

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

3321

2612

else:

3322

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

3323

exc_info=e)

2613

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

2614

exc_info=e)

3324

2615

raise

3325

2616

except EOFError as e:

3326

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

3327

exc_info=e)

3328

2617

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

2618

"EOFError:",

2619

exc_info=e)

2620

3329

2621

with PGPEngine() as pgp:

3330

2622

for client_name, client in clients_data.items():

3331

2623

# Skip removed clients

3332

2624

if client_name not in client_settings:

3333

2625

continue

3334

2626

3335

2627

# Decide which value to use after restoring saved state.

3336

2628

# We have three different values: Old config file,

3337

2629

# new config file, and saved state.

3348

2640

client[name] = value

3349

2641

except KeyError:

3350

2642

pass

3351

2643

3352

2644

# Clients who has passed its expire date can still be

3353

2645

# enabled if its last checker was successful. A Client

3354

2646

# whose checker succeeded before we stored its state is

3357

2649

if client["enabled"]:

3358

2650

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

3359

2651

if not client["last_checked_ok"]:

3360

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

3361

" never performed a successful"

3362

" checker", client_name)

2652

logger.warning(

2653

"disabling client {} - Client never "

2654

"performed a successful checker".format(

2655

client_name))

3363

2656

client["enabled"] = False

3364

2657

elif client["last_checker_status"] != 0:

3365

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

3366

" last checker failed with error"

3367

" code %s", client_name,

3368

client["last_checker_status"])

2658

logger.warning(

2659

"disabling client {} - Client last"

2660

" checker failed with error code"

2661

" {}".format(

2662

client_name,

2663

client["last_checker_status"]))

3369

2664

client["enabled"] = False

3370

2665

else:

3371

2666

client["expires"] = (

3372

2667

datetime.datetime.utcnow()

3373

2668

+ client["timeout"])

3374

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

3375

" enabled", client_name)

2669

logger.debug("Last checker succeeded,"

2670

" keeping {} enabled".format(

2671

client_name))

3376

2672

try:

3377

2673

client["secret"] = pgp.decrypt(

3378

2674

client["encrypted_secret"],

3379

2675

client_settings[client_name]["secret"])

3380

2676

except PGPError:

3381

2677

# If decryption fails, we use secret from new settings

3382

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

3383

client_name)

2678

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

2679

client_name))

3384

2680

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

3385

2681

["secret"])

3386

2682

3387

2683

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

3388

2684

for client_name in (set(old_client_settings)

3389

2685

- set(client_settings)):

3391

2687

for client_name in (set(client_settings)

3392

2688

- set(old_client_settings)):

3393

2689

clients_data[client_name] = client_settings[client_name]

3394

2690

3395

2691

# Create all client objects

3396

2692

for client_name, client in clients_data.items():

3397

2693

tcp_server.clients[client_name] = client_class(

3398

name=client_name,

3399

settings=client,

3400

server_settings=server_settings)

3401

2694

name = client_name,

2695

settings = client,

2696

server_settings = server_settings)

2697

3402

2698

if not tcp_server.clients:

3403

log.warning("No clients defined")

3404

2699

logger.warning("No clients defined")

2700

3405

2701

if not foreground:

3406

2702

if pidfile is not None:

3407

pid = os.getpid()

3408

2703

try:

3409

2704

with pidfile:

3410

print(pid, file=pidfile)

2705

pid = os.getpid()

2706

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

3411

2707

except IOError:

3412

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

3413

pidfilename, pid)

2708

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

2709

pidfilename, pid)

3414

2710

del pidfile

3415

2711

del pidfilename

3416

3417

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

3418

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3419

lambda: main_loop.quit() and False)

3420

2712

2713

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

2714

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

2715

3421

2716

if use_dbus:

3422

2717

3423

2718

@alternate_dbus_interfaces(

3424

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

3425

class MandosDBusService(DBusObjectWithObjectManager):

2719

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

2720

class MandosDBusService(DBusObjectWithProperties):

3426

2721

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

3427

2722

3428

2723

def __init__(self):

3429

2724

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

3430

2725

3431

2726

_interface = "se.recompile.Mandos"

3432

2727

2728

@dbus_interface_annotations(_interface)

2729

def _foo(self):

2730

return {

2731

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

2732

"false" }

2733

3433

2734

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

3434

2735

def ClientAdded(self, objpath):

3435

2736

"D-Bus signal"

3436

2737

pass

3437

2738

3438

2739

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

3439

def ClientNotFound(self, key_id, address):

2740

def ClientNotFound(self, fingerprint, address):

3440

2741

"D-Bus signal"

3441

2742

pass

3442

3443

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

3444

"true"})

2743

3445

2744

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

3446

2745

def ClientRemoved(self, objpath, name):

3447

2746

"D-Bus signal"

3448

2747

pass

3449

3450

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

3451

"true"})

2748

3452

2749

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

3453

2750

def GetAllClients(self):

3454

2751

"D-Bus method"

3455

2752

return dbus.Array(c.dbus_object_path for c in

3456

tcp_server.clients.values())

3457

3458

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

3459

"true"})

2753

tcp_server.clients.itervalues())

2754

3460

2755

@dbus.service.method(_interface,

3461

2756

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

3462

2757

def GetAllClientsWithProperties(self):

3463

2758

"D-Bus method"

3464

2759

return dbus.Dictionary(

3465

{c.dbus_object_path: c.GetAll(

3466

"se.recompile.Mandos.Client")

3467

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

2760

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

2761

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

3468

2762

signature="oa{sv}")

3469

2763

3470

2764

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

3471

2765

def RemoveClient(self, object_path):

3472

2766

"D-Bus method"

3473

for c in tcp_server.clients.values():

2767

for c in tcp_server.clients.itervalues():

3474

2768

if c.dbus_object_path == object_path:

3475

2769

del tcp_server.clients[c.name]

3476

2770

c.remove_from_connection()

3477

# Don't signal the disabling

2771

# Don't signal anything except ClientRemoved

3478

2772

c.disable(quiet=True)

3479

# Emit D-Bus signal for removal

3480

self.client_removed_signal(c)

2773

# Emit D-Bus signal

2774

self.ClientRemoved(object_path, c.name)

3481

2775

return

3482

2776

raise KeyError(object_path)

3483

2777

3484

2778

del _interface

3485

3486

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3487

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

3488

def GetManagedObjects(self):

3489

"""D-Bus method"""

3490

return dbus.Dictionary(

3491

{client.dbus_object_path:

3492

dbus.Dictionary(

3493

{interface: client.GetAll(interface)

3494

for interface in

3495

client._get_all_interface_names()})

3496

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

3497

3498

def client_added_signal(self, client):

3499

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

3500

if use_dbus:

3501

# New standard signal

3502

self.InterfacesAdded(

3503

client.dbus_object_path,

3504

dbus.Dictionary(

3505

{interface: client.GetAll(interface)

3506

for interface in

3507

client._get_all_interface_names()}))

3508

# Old signal

3509

self.ClientAdded(client.dbus_object_path)

3510

3511

def client_removed_signal(self, client):

3512

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

3513

if use_dbus:

3514

# New standard signal

3515

self.InterfacesRemoved(

3516

client.dbus_object_path,

3517

client._get_all_interface_names())

3518

# Old signal

3519

self.ClientRemoved(client.dbus_object_path,

3520

client.name)

3521

2779

3522

2780

mandos_dbus_service = MandosDBusService()

3523

3524

# Save modules to variables to exempt the modules from being

3525

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

3526

mp = multiprocessing

3527

wn = wnull

3528

2781

3529

2782

def cleanup():

3530

2783

"Cleanup function; run on exit"

3531

2784

if zeroconf:

3532

2785

service.cleanup()

3533

3534

mp.active_children()

3535

wn.close()

2786

2787

multiprocessing.active_children()

2788

wnull.close()

3536

2789

if not (tcp_server.clients or client_settings):

3537

2790

return

3538

2791

3539

2792

# Store client before exiting. Secrets are encrypted with key

3540

2793

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

3541

2794

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

3542

2795

clients = {}

3543

2796

with PGPEngine() as pgp:

3544

for client in tcp_server.clients.values():

2797

for client in tcp_server.clients.itervalues():

3545

2798

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

3546

2799

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

3547

2800

key)

3548

2801

client_dict = {}

3549

2802

3550

2803

# A list of attributes that can not be pickled

3551

2804

# + secret.

3552

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

3553

"checker", "server_settings"}

2805

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

2806

"checker", "server_settings" }

3554

2807

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

3555

2808

.Object):

3556

2809

exclude.add(name)

3557

2810

3558

2811

client_dict["encrypted_secret"] = (client

3559

2812

.encrypted_secret)

3560

2813

for attr in client.client_structure:

3561

2814

if attr not in exclude:

3562

2815

client_dict[attr] = getattr(client, attr)

3563

2816

3564

2817

clients[client.name] = client_dict

3565

2818

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

3566

2819

3567

2820

try:

3568

2821

with tempfile.NamedTemporaryFile(

3569

mode="wb",

2822

mode='wb',

3570

2823

suffix=".pickle",

3571

prefix="clients-",

2824

prefix='clients-',

3572

2825

dir=os.path.dirname(stored_state_path),

3573

2826

delete=False) as stored_state:

3574

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

3575

protocol=2)

2827

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

3576

2828

tempname = stored_state.name

3577

2829

os.rename(tempname, stored_state_path)

3578

2830

except (IOError, OSError) as e:

3582

2834

except NameError:

3583

2835

pass

3584

2836

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

3585

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

3586

os.strerror(e.errno))

2837

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

2838

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

3587

2839

else:

3588

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

3589

exc_info=e)

2840

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

2841

exc_info=e)

3590

2842

raise

3591

2843

3592

2844

# Delete all clients, and settings from config

3593

2845

while tcp_server.clients:

3594

2846

name, client = tcp_server.clients.popitem()

3595

2847

if use_dbus:

3596

2848

client.remove_from_connection()

3597

# Don't signal the disabling

2849

# Don't signal anything except ClientRemoved

3598

2850

client.disable(quiet=True)

3599

# Emit D-Bus signal for removal

3600

2851

if use_dbus:

3601

mandos_dbus_service.client_removed_signal(client)

2852

# Emit D-Bus signal

2853

mandos_dbus_service.ClientRemoved(

2854

client.dbus_object_path, client.name)

3602

2855

client_settings.clear()

3603

2856

3604

2857

atexit.register(cleanup)

3605

3606

for client in tcp_server.clients.values():

2858

2859

for client in tcp_server.clients.itervalues():

3607

2860

if use_dbus:

3608

# Emit D-Bus signal for adding

3609

mandos_dbus_service.client_added_signal(client)

2861

# Emit D-Bus signal

2862

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3610

2863

# Need to initiate checking of clients

3611

2864

if client.enabled:

3612

2865

client.init_checker()

3613

2866

3614

2867

tcp_server.enable()

3615

2868

tcp_server.server_activate()

3616

2869

3617

2870

# Find out what port we got

3618

2871

if zeroconf:

3619

2872

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

3620

2873

if use_ipv6:

3621

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

3622

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

2874

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

2875

" flowinfo %d, scope_id %d",

2876

*tcp_server.socket.getsockname())

3623

2877

else: # IPv4

3624

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

3625

*tcp_server.socket.getsockname())

3626

3627

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

3628

2878

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

2879

*tcp_server.socket.getsockname())

2880

2881

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

2882

3629

2883

try:

3630

2884

if zeroconf:

3631

2885

# From the Avahi example code

3632

2886

try:

3633

2887

service.activate()

3634

2888

except dbus.exceptions.DBusException as error:

3635

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

2889

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

3636

2890

cleanup()

3637

2891

sys.exit(1)

3638

2892

# End of Avahi example code

3639

3640

GLib.io_add_watch(

3641

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

3642

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3643

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

3644

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

3645

3646

log.debug("Starting main loop")

2893

2894

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

2895

lambda *args, **kwargs:

2896

(tcp_server.handle_request

2897

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

2898

2899

logger.debug("Starting main loop")

3647

2900

main_loop.run()

3648

2901

except AvahiError as error:

3649

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

2902

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

3650

2903

cleanup()

3651

2904

sys.exit(1)

3652

2905

except KeyboardInterrupt:

3653

2906

if debug:

3654

2907

print("", file=sys.stderr)

3655

log.debug("Server received KeyboardInterrupt")

3656

log.debug("Server exiting")

2908

logger.debug("Server received KeyboardInterrupt")

2909

logger.debug("Server exiting")

3657

2910

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

3658

2911

cleanup()

3659

2912

3660

3661

def parse_test_args():

3662

# type: () -> argparse.Namespace

3663

parser = argparse.ArgumentParser(add_help=False)

3664

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

3665

parser.add_argument("--prefix", )

3666

args, unknown_args = parser.parse_known_args()

3667

if args.check:

3668

# Remove test options from sys.argv

3669

sys.argv[1:] = unknown_args

3670

return args

3671

3672

# Add all tests from doctest strings

3673

def load_tests(loader, tests, none):

3674

import doctest

3675

tests.addTests(doctest.DocTestSuite())

3676

return tests

3677

3678

if __name__ == "__main__":

3679

options = parse_test_args()

3680

try:

3681

if options.check:

3682

extra_test_prefix = options.prefix

3683

if extra_test_prefix is not None:

3684

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

3685

.result.wasSuccessful()):

3686

sys.exit(1)

3687

class ExtraTestLoader(unittest.TestLoader):

3688

testMethodPrefix = extra_test_prefix

3689

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

3690

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

3691

else:

3692

unittest.main(argv=[""])

3693

else:

3694

main()

3695

finally:

3696

logging.shutdown()

3697

3698

# Local Variables:

3699

# run-tests:

3700

# (lambda (&optional extra)

3701

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

3702

# extra))

3703

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

3704

# (funcall remove-test-window)

3705

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

3706

# run-tests-in-test-buffer:

3707

# (lambda (dir &optional extra)

3708

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

3709

# (setq buffer-read-only nil

3710

# default-directory dir)

3711

# (erase-buffer)

3712

# (compilation-mode))

3713

# (let ((process-result

3714

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

3715

# (process-file-shell-command

3716

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

3717

# (and (numberp process-result)

3718

# (= process-result 0))))

3719

# get-command-line:

3720

# (lambda (&optional extra)

3721

# (let ((quoted-script

3722

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

3723

# (format

3724

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

3725

# quoted-script)))

3726

# get-script-name:

3727

# (lambda ()

3728

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

3729

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

3730

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

3731

# (buffer-file-name))))

3732

# remove-test-window:

3733

# (lambda ()

3734

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

3735

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

3736

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

3737

# (lambda ()

3738

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

3739

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

3740

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

3741

# (display-buffer-overriding-action

3742

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

3743

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

3744

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

3745

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

3746

# eval:

3747

# (progn

3748

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

3749

# (funcall run-tests t)))

3750

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

3751

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

3752

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

3753

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

3754

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

3755

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

3756

# End:

2913

2914

if __name__ == '__main__':

2915

main()