/mandos/trunk : revision 237.4.138

1

#!/usr/bin/python2.7

2

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

3

#

1

#!/usr/bin/python3 -bI

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

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

18

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

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

from future_builtins import *

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

38

41

42

import sys

43

import unittest

44

import argparse

45

import logging

46

import os

39

47

try:

40

48

import SocketServer as socketserver

41

49

except ImportError:

42

50

import socketserver

43

51

import socket

44

import argparse

45

52

import datetime

46

53

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

53

54

try:

54

55

import ConfigParser as configparser

55

56

except ImportError:

56

57

import configparser

57

import sys

58

import re

59

import os

60

59

import signal

61

60

import subprocess

62

61

import atexit

63

62

import stat

64

import logging

65

63

import logging.handlers

66

64

import pwd

67

65

import contextlib

79

77

import itertools

80

78

import collections

81

79

import codecs

80

import random

81

import shlex

82

83

import dbus

84

import dbus.service

85

try:

86

import gobject

87

except ImportError:

88

from gi.repository import GObject as gobject

89

import avahi

85

import gi

86

from gi.repository import GLib

90

87

from dbus.mainloop.glib import DBusGMainLoop

91

88

import ctypes

92

89

import ctypes.util

93

90

import xml.dom.minidom

94

91

import inspect

95

92

96

try:

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:

97

122

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

98

123

except AttributeError:

99

124

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

100

127

from IN import SO_BINDTODEVICE

101

128

except ImportError:

102

SO_BINDTODEVICE = None

103

104

if sys.version_info.major == 2:

105

str = unicode

106

107

version = "1.6.9"

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"

108

147

stored_state_file = "clients.pickle"

109

148

110

logger = logging.getLogger()

149

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

150

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

111

151

syslogger = None

112

152

113

153

try:

114

154

if_nametoindex = ctypes.cdll.LoadLibrary(

115

155

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

116

156

except (OSError, AttributeError):

117

157

118

158

def if_nametoindex(interface):

119

159

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

120

160

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

125

165

return interface_index

126

166

127

167

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

128

184

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

129

185

"""init logger and add loglevel"""

130

186

131

187

global syslogger

132

188

syslogger = (logging.handlers.SysLogHandler(

133

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

134

address = "/dev/log"))

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

135

191

syslogger.setFormatter(logging.Formatter

136

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

137

' %(message)s'))

138

logger.addHandler(syslogger)

139

192

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

193

" %(message)s"))

194

log.addHandler(syslogger)

195

140

196

if debug:

141

197

console = logging.StreamHandler()

142

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

143

' [%(process)d]:'

144

' %(levelname)s:'

145

' %(message)s'))

146

logger.addHandler(console)

147

logger.setLevel(level)

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)

148

204

149

205

150

206

class PGPError(Exception):

152

208

pass

153

209

154

210

155

class PGPEngine(object):

211

class PGPEngine:

156

212

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

157

213

158

214

def __init__(self):

159

215

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

160

self.gnupgargs = ['--batch',

161

'--home', self.tempdir,

162

'--force-mdc',

163

'--quiet',

164

'--no-use-agent']

165

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

166

235

def __enter__(self):

167

236

return self

168

237

169

238

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

170

239

self._cleanup()

171

240

return False

172

241

173

242

def __del__(self):

174

243

self._cleanup()

175

244

176

245

def _cleanup(self):

177

246

if self.tempdir is not None:

178

247

# Delete contents of tempdir

179

248

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

180

topdown = False):

249

topdown=False):

181

250

for filename in files:

182

251

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

183

252

for dirname in dirs:

185

254

# Remove tempdir

186

255

os.rmdir(self.tempdir)

187

256

self.tempdir = None

188

257

189

258

def password_encode(self, password):

190

259

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

191

260

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

196

265

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

197

266

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

198

267

return encoded

199

268

200

269

def encrypt(self, data, password):

201

270

passphrase = self.password_encode(password)

202

271

with tempfile.NamedTemporaryFile(

203

272

dir=self.tempdir) as passfile:

204

273

passfile.write(passphrase)

205

274

passfile.flush()

206

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

207

'--passphrase-file',

275

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

276

"--passphrase-file",

208

277

passfile.name]

209

278

+ self.gnupgargs,

210

stdin = subprocess.PIPE,

211

stdout = subprocess.PIPE,

212

stderr = subprocess.PIPE)

213

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

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

214

283

if proc.returncode != 0:

215

284

raise PGPError(err)

216

285

return ciphertext

217

286

218

287

def decrypt(self, data, password):

219

288

passphrase = self.password_encode(password)

220

289

with tempfile.NamedTemporaryFile(

221

dir = self.tempdir) as passfile:

290

dir=self.tempdir) as passfile:

222

291

passfile.write(passphrase)

223

292

passfile.flush()

224

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

225

'--passphrase-file',

293

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

294

"--passphrase-file",

226

295

passfile.name]

227

296

+ self.gnupgargs,

228

stdin = subprocess.PIPE,

229

stdout = subprocess.PIPE,

230

stderr = subprocess.PIPE)

231

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

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

232

301

if proc.returncode != 0:

233

302

raise PGPError(err)

234

303

return decrypted_plaintext

235

304

236

305

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

237

332

class AvahiError(Exception):

238

333

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

239

334

self.value = value

249

344

pass

250

345

251

346

252

class AvahiService(object):

347

class AvahiService:

253

348

"""An Avahi (Zeroconf) service.

254

349

255

350

Attributes:

256

351

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

257

352

Used to optionally bind to the specified interface.

258

name: string; Example: 'Mandos'

259

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

353

name: string; Example: "Mandos"

354

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

260

355

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

261

356

port: integer; what port to announce

262

357

TXT: list of strings; TXT record for the service

269

364

server: D-Bus Server

270

365

bus: dbus.SystemBus()

271

366

"""

272

367

273

368

def __init__(self,

274

interface = avahi.IF_UNSPEC,

275

name = None,

276

servicetype = None,

277

port = None,

278

TXT = None,

279

domain = "",

280

host = "",

281

max_renames = 32768,

282

protocol = avahi.PROTO_UNSPEC,

283

bus = None):

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

284

379

self.interface = interface

285

380

self.name = name

286

381

self.type = servicetype

295

390

self.server = None

296

391

self.bus = bus

297

392

self.entry_group_state_changed_match = None

298

393

299

394

def rename(self, remove=True):

300

395

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

301

396

if self.rename_count >= self.max_renames:

302

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

303

" after %i retries, exiting.",

304

self.rename_count)

397

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

398

" after %i retries, exiting.",

399

self.rename_count)

305

400

raise AvahiServiceError("Too many renames")

306

401

self.name = str(

307

402

self.server.GetAlternativeServiceName(self.name))

308

403

self.rename_count += 1

309

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

310

self.name)

404

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

405

self.name)

311

406

if remove:

312

407

self.remove()

313

408

try:

315

410

except dbus.exceptions.DBusException as error:

316

411

if (error.get_dbus_name()

317

412

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

318

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

413

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

319

414

return self.rename(remove=False)

320

415

else:

321

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

416

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

322

417

self.cleanup()

323

418

os._exit(1)

324

419

325

420

def remove(self):

326

421

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

327

422

if self.entry_group_state_changed_match is not None:

329

424

self.entry_group_state_changed_match = None

330

425

if self.group is not None:

331

426

self.group.Reset()

332

427

333

428

def add(self):

334

429

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

335

430

self.remove()

340

435

avahi.DBUS_INTERFACE_ENTRY_GROUP)

341

436

self.entry_group_state_changed_match = (

342

437

self.group.connect_to_signal(

343

'StateChanged', self.entry_group_state_changed))

344

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

345

self.name, self.type)

438

"StateChanged", self.entry_group_state_changed))

439

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

440

self.name, self.type)

346

441

self.group.AddService(

347

442

self.interface,

348

443

self.protocol,

352

447

dbus.UInt16(self.port),

353

448

avahi.string_array_to_txt_array(self.TXT))

354

449

self.group.Commit()

355

450

356

451

def entry_group_state_changed(self, state, error):

357

452

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

358

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

359

453

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

454

360

455

if state == avahi.ENTRY_GROUP_ESTABLISHED:

361

logger.debug("Zeroconf service established.")

456

log.debug("Zeroconf service established.")

362

457

elif state == avahi.ENTRY_GROUP_COLLISION:

363

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

458

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

364

459

self.rename()

365

460

elif state == avahi.ENTRY_GROUP_FAILURE:

366

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

367

str(error))

461

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

462

str(error))

368

463

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

369

464

370

465

def cleanup(self):

371

466

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

372

467

if self.group is not None:

377

472

pass

378

473

self.group = None

379

474

self.remove()

380

475

381

476

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

382

477

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

383

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

478

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

384

479

bad_states = {

385

480

avahi.SERVER_INVALID: "Zeroconf server invalid",

386

481

avahi.SERVER_REGISTERING: None,

390

485

if state in bad_states:

391

486

if bad_states[state] is not None:

392

487

if error is None:

393

logger.error(bad_states[state])

488

log.error(bad_states[state])

394

489

else:

395

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

490

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

396

491

self.cleanup()

397

492

elif state == avahi.SERVER_RUNNING:

398

self.add()

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)

399

504

else:

400

505

if error is None:

401

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

506

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

402

507

else:

403

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

404

508

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

509

405

510

def activate(self):

406

511

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

407

512

if self.server is None:

418

523

class AvahiServiceToSyslog(AvahiService):

419

524

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

420

525

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

421

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

526

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

527

**kwargs)

422

528

syslogger.setFormatter(logging.Formatter(

423

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

529

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

424

530

.format(self.name)))

425

531

return ret

426

532

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

427

863

def call_pipe(connection, # : multiprocessing.Connection

428

864

func, *args, **kwargs):

429

865

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

430

866

431

867

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

432

868

return value on the provided multiprocessing.Connection.

433

869

"""

434

870

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

435

871

connection.close()

436

872

437

class Client(object):

873

874

class Client:

438

875

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

439

876

440

877

Attributes:

441

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

878

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

442

879

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

443

880

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

444

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

445

to see if the client lives.

446

'None' if no process is running.

447

checker_callback_tag: a gobject event source tag, or None

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

448

885

checker_command: string; External command which is run to check

449

886

if client lives. %() expansions are done at

450

887

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

451

888

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

452

checker_initiator_tag: a gobject event source tag, or None

889

checker_initiator_tag: a GLib event source tag, or None

453

890

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

454

891

client_structure: Object describing what attributes a client has

455

892

and is used for storing the client at exit

456

893

current_checker_command: string; current running checker_command

457

disable_initiator_tag: a gobject event source tag, or None

894

disable_initiator_tag: a GLib event source tag, or None

458

895

enabled: bool()

459

896

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

460

uniquely identify the client

897

uniquely identify an OpenPGP client

898

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

899

a client using raw public keys

461

900

host: string; available for use by the checker command

462

901

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

463

902

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

479

918

disabled, or None

480

919

server_settings: The server_settings dict from main()

481

920

"""

482

921

483

922

runtime_expansions = ("approval_delay", "approval_duration",

484

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

923

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

485

924

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

486

925

"last_approval_request", "last_checked_ok",

487

926

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

496

935

"approved_by_default": "True",

497

936

"enabled": "True",

498

937

}

499

938

500

939

@staticmethod

501

940

def config_parser(config):

502

941

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

509

948

for client_name in config.sections():

510

949

section = dict(config.items(client_name))

511

950

client = settings[client_name] = {}

512

951

513

952

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

514

953

# Reformat values from string types to Python types

515

954

client["approved_by_default"] = config.getboolean(

516

955

client_name, "approved_by_default")

517

956

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

518

957

"enabled")

519

520

# Uppercase and remove spaces from fingerprint for later

521

# comparison purposes with return value from the

522

# fingerprint() function

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

523

964

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

524

965

.replace(" ", ""))

525

966

if "secret" in section:

526

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

967

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

968

.encode("utf-8"),

969

"base64")

527

970

elif "secfile" in section:

528

971

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

529

972

(section["secfile"])),

544

987

client["last_approval_request"] = None

545

988

client["last_checked_ok"] = None

546

989

client["last_checker_status"] = -2

547

990

548

991

return settings

549

550

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

992

993

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

551

994

self.name = name

552

995

if server_settings is None:

553

996

server_settings = {}

555

998

# adding all client settings

556

999

for setting, value in settings.items():

557

1000

setattr(self, setting, value)

558

1001

559

1002

if self.enabled:

560

1003

if not hasattr(self, "last_enabled"):

561

1004

self.last_enabled = datetime.datetime.utcnow()

565

1008

else:

566

1009

self.last_enabled = None

567

1010

self.expires = None

568

569

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

570

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

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)

571

1015

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

572

1016

datetime.datetime.utcnow())

573

1017

574

1018

# attributes specific for this server instance

575

1019

self.checker = None

576

1020

self.checker_initiator_tag = None

582

1026

self.changedstate = multiprocessing_manager.Condition(

583

1027

multiprocessing_manager.Lock())

584

1028

self.client_structure = [attr

585

for attr in self.__dict__.iterkeys()

1029

for attr in self.__dict__.keys()

586

1030

if not attr.startswith("_")]

587

1031

self.client_structure.append("client_structure")

588

1032

589

1033

for name, t in inspect.getmembers(

590

1034

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

591

1035

if not name.startswith("_"):

592

1036

self.client_structure.append(name)

593

1037

594

1038

# Send notice to process children that client state has changed

595

1039

def send_changedstate(self):

596

1040

with self.changedstate:

597

1041

self.changedstate.notify_all()

598

1042

599

1043

def enable(self):

600

1044

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

601

1045

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

606

1050

self.last_enabled = datetime.datetime.utcnow()

607

1051

self.init_checker()

608

1052

self.send_changedstate()

609

1053

610

1054

def disable(self, quiet=True):

611

1055

"""Disable this client."""

612

1056

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

613

1057

return False

614

1058

if not quiet:

615

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

1059

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

616

1060

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

617

gobject.source_remove(self.disable_initiator_tag)

1061

GLib.source_remove(self.disable_initiator_tag)

618

1062

self.disable_initiator_tag = None

619

1063

self.expires = None

620

1064

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

621

gobject.source_remove(self.checker_initiator_tag)

1065

GLib.source_remove(self.checker_initiator_tag)

622

1066

self.checker_initiator_tag = None

623

1067

self.stop_checker()

624

1068

self.enabled = False

625

1069

if not quiet:

626

1070

self.send_changedstate()

627

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

1071

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

628

1072

return False

629

1073

630

1074

def __del__(self):

631

1075

self.disable()

632

1076

633

1077

def init_checker(self):

634

1078

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

635

1079

# and every interval from then on.

636

1080

if self.checker_initiator_tag is not None:

637

gobject.source_remove(self.checker_initiator_tag)

638

self.checker_initiator_tag = gobject.timeout_add(

639

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

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

640

1085

self.start_checker)

641

1086

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

642

1087

if self.disable_initiator_tag is not None:

643

gobject.source_remove(self.disable_initiator_tag)

644

self.disable_initiator_tag = gobject.timeout_add(

1088

GLib.source_remove(self.disable_initiator_tag)

1089

self.disable_initiator_tag = GLib.timeout_add(

645

1090

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

646

1091

# Also start a new checker *right now*.

647

1092

self.start_checker()

648

1093

649

1094

def checker_callback(self, source, condition, connection,

650

1095

command):

651

1096

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

652

self.checker_callback_tag = None

653

self.checker = None

654

1097

# Read return code from connection (see call_pipe)

655

1098

returncode = connection.recv()

656

1099

connection.close()

657

1100

if self.checker is not None:

1101

self.checker.join()

1102

self.checker_callback_tag = None

1103

self.checker = None

1104

658

1105

if returncode >= 0:

659

1106

self.last_checker_status = returncode

660

1107

self.last_checker_signal = None

661

1108

if self.last_checker_status == 0:

662

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

663

vars(self))

1109

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

664

1110

self.checked_ok()

665

1111

else:

666

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

1112

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

667

1113

else:

668

1114

self.last_checker_status = -1

669

1115

self.last_checker_signal = -returncode

670

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

671

vars(self))

1116

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

672

1117

return False

673

1118

674

1119

def checked_ok(self):

675

1120

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

676

1121

self.last_checked_ok = datetime.datetime.utcnow()

677

1122

self.last_checker_status = 0

678

1123

self.last_checker_signal = None

679

1124

self.bump_timeout()

680

1125

681

1126

def bump_timeout(self, timeout=None):

682

1127

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

683

1128

if timeout is None:

684

1129

timeout = self.timeout

685

1130

if self.disable_initiator_tag is not None:

686

gobject.source_remove(self.disable_initiator_tag)

1131

GLib.source_remove(self.disable_initiator_tag)

687

1132

self.disable_initiator_tag = None

688

1133

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

689

self.disable_initiator_tag = gobject.timeout_add(

1134

self.disable_initiator_tag = GLib.timeout_add(

690

1135

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

691

1136

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

692

1137

693

1138

def need_approval(self):

694

1139

self.last_approval_request = datetime.datetime.utcnow()

695

1140

696

1141

def start_checker(self):

697

1142

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

698

1143

699

1144

If a checker already exists, leave it running and do

700

1145

nothing."""

701

1146

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

706

1151

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

707

1152

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

708

1153

# should be.

709

1154

710

1155

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

711

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

1156

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

712

1157

self.checker.join()

713

1158

self.checker = None

714

1159

# Start a new checker if needed

715

1160

if self.checker is None:

716

1161

# Escape attributes for the shell

717

1162

escaped_attrs = {

718

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

719

for attr in self.runtime_expansions }

1163

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

1164

for attr in self.runtime_expansions}

720

1165

try:

721

1166

command = self.checker_command % escaped_attrs

722

1167

except TypeError as error:

723

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

724

self.checker_command,

725

exc_info=error)

1168

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

1169

self.checker_command, exc_info=error)

726

1170

return True # Try again later

727

1171

self.current_checker_command = command

728

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

729

self.name)

1172

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

730

1173

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

731

1174

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

732

1175

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

734

1177

# The exception is when not debugging but nevertheless

735

1178

# running in the foreground; use the previously

736

1179

# created wnull.

737

popen_args = { "close_fds": True,

738

"shell": True,

739

"cwd": "/" }

1180

popen_args = {"close_fds": True,

1181

"shell": True,

1182

"cwd": "/"}

740

1183

if (not self.server_settings["debug"]

741

1184

and self.server_settings["foreground"]):

742

1185

popen_args.update({"stdout": wnull,

743

"stderr": wnull })

744

pipe = multiprocessing.Pipe(duplex = False)

1186

"stderr": wnull})

1187

pipe = multiprocessing.Pipe(duplex=False)

745

1188

self.checker = multiprocessing.Process(

746

target = call_pipe,

747

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

748

kwargs = popen_args)

1189

target=call_pipe,

1190

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

1191

kwargs=popen_args)

749

1192

self.checker.start()

750

self.checker_callback_tag = gobject.io_add_watch(

751

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

1193

self.checker_callback_tag = GLib.io_add_watch(

1194

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

1195

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

752

1196

self.checker_callback, pipe[0], command)

753

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

1197

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

754

1198

return True

755

1199

756

1200

def stop_checker(self):

757

1201

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

758

1202

if self.checker_callback_tag:

759

gobject.source_remove(self.checker_callback_tag)

1203

GLib.source_remove(self.checker_callback_tag)

760

1204

self.checker_callback_tag = None

761

1205

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

762

1206

return

763

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

1207

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

764

1208

self.checker.terminate()

765

1209

self.checker = None

766

1210

771

1215

byte_arrays=False):

772

1216

"""Decorators for marking methods of a DBusObjectWithProperties to

773

1217

become properties on the D-Bus.

774

1218

775

1219

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

776

1220

and with one argument by "Set".

777

1221

778

1222

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

779

1223

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

780

1224

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

784

1228

if byte_arrays and signature != "ay":

785

1229

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

786

1230

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

787

1231

788

1232

def decorator(func):

789

1233

func._dbus_is_property = True

790

1234

func._dbus_interface = dbus_interface

793

1237

func._dbus_name = func.__name__

794

1238

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

795

1239

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

796

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1240

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

797

1241

return func

798

1242

799

1243

return decorator

800

1244

801

1245

802

1246

def dbus_interface_annotations(dbus_interface):

803

1247

"""Decorator for marking functions returning interface annotations

804

1248

805

1249

Usage:

806

1250

807

1251

@dbus_interface_annotations("org.example.Interface")

808

1252

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

809

1253

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

810

1254

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

811

1255

"false"}

812

1256

"""

813

1257

814

1258

def decorator(func):

815

1259

func._dbus_is_interface = True

816

1260

func._dbus_interface = dbus_interface

817

1261

func._dbus_name = dbus_interface

818

1262

return func

819

1263

820

1264

return decorator

821

1265

822

1266

823

1267

def dbus_annotations(annotations):

824

1268

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

825

1269

Usage:

826

1270

827

1271

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

828

1272

"org.freedesktop.DBus.Property."

829

1273

"EmitsChangedSignal": "false"})

831

1275

access="r")

832

1276

def Property_dbus_property(self):

833

1277

return dbus.Boolean(False)

1278

1279

See also the DBusObjectWithAnnotations class.

834

1280

"""

835

1281

836

1282

def decorator(func):

837

1283

func._dbus_annotations = annotations

838

1284

return func

839

1285

840

1286

return decorator

841

1287

842

1288

858

1304

pass

859

1305

860

1306

861

class DBusObjectWithProperties(dbus.service.Object):

862

"""A D-Bus object with properties.

863

864

Classes inheriting from this can use the dbus_service_property

865

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

866

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

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.

867

1312

"""

868

1313

869

1314

@staticmethod

870

1315

def _is_dbus_thing(thing):

871

1316

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

872

1317

873

1318

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

874

1319

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

875

1320

"""

876

1321

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

877

1322

False)

878

1323

879

1324

def _get_all_dbus_things(self, thing):

880

1325

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

881

1326

"""

884

1329

for cls in self.__class__.__mro__

885

1330

for name, athing in

886

1331

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

887

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

888

1404

def _get_dbus_property(self, interface_name, property_name):

889

1405

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

890

1406

property with the specified name and interface.

895

1411

if (value._dbus_name == property_name

896

1412

and value._dbus_interface == interface_name):

897

1413

return value.__get__(self)

898

1414

899

1415

# No such property

900

1416

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

901

1417

self.dbus_object_path, interface_name, property_name))

902

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

903

1428

@dbus.service.method(dbus.PROPERTIES_IFACE,

904

1429

in_signature="ss",

905

1430

out_signature="v")

913

1438

if not hasattr(value, "variant_level"):

914

1439

return value

915

1440

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

916

1441

917

1442

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

918

1443

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

919

1444

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

928

1453

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

929

1454

"'ay' signature {!r}"

930

1455

.format(prop._dbus_signature))

931

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

932

for byte in value))

1456

value = dbus.ByteArray(bytes(value))

933

1457

prop(value)

934

1458

935

1459

@dbus.service.method(dbus.PROPERTIES_IFACE,

936

1460

in_signature="s",

937

1461

out_signature="a{sv}")

938

1462

def GetAll(self, interface_name):

939

1463

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

940

1464

standard.

941

1465

942

1466

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

943

1467

"""

944

1468

properties = {}

955

1479

properties[name] = value

956

1480

continue

957

1481

properties[name] = type(value)(

958

value, variant_level = value.variant_level + 1)

1482

value, variant_level=value.variant_level + 1)

959

1483

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

960

1484

961

1485

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

962

1486

def PropertiesChanged(self, interface_name, changed_properties,

963

1487

invalidated_properties):

965

1489

standard.

966

1490

"""

967

1491

pass

968

1492

969

1493

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

970

1494

out_signature="s",

971

path_keyword='object_path',

972

connection_keyword='connection')

1495

path_keyword="object_path",

1496

connection_keyword="connection")

973

1497

def Introspect(self, object_path, connection):

974

1498

"""Overloading of standard D-Bus method.

975

1499

976

1500

Inserts property tags and interface annotation tags.

977

1501

"""

978

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

979

connection)

1502

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1503

object_path,

1504

connection)

980

1505

try:

981

1506

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

982

1507

983

1508

def make_tag(document, name, prop):

984

1509

e = document.createElement("property")

985

1510

e.setAttribute("name", name)

986

1511

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

987

1512

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

988

1513

return e

989

1514

990

1515

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

991

1516

# Add property tags

992

1517

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

995

1520

if prop._dbus_interface

996

1521

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

997

1522

if_tag.appendChild(tag)

998

# Add annotation tags

999

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

1000

for tag in if_tag.getElementsByTagName(typ):

1001

annots = dict()

1002

for name, prop in (self.

1003

_get_all_dbus_things(typ)):

1004

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

1005

and prop._dbus_interface

1006

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

1007

annots.update(getattr(

1008

prop, "_dbus_annotations", {}))

1009

for name, value in annots.items():

1010

ann_tag = document.createElement(

1011

"annotation")

1012

ann_tag.setAttribute("name", name)

1013

ann_tag.setAttribute("value", value)

1014

tag.appendChild(ann_tag)

1015

# Add interface annotation tags

1016

for annotation, value in dict(

1017

itertools.chain.from_iterable(

1018

annotations().items()

1019

for name, annotations

1020

in self._get_all_dbus_things("interface")

1021

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

1022

)).items():

1023

ann_tag = document.createElement("annotation")

1024

ann_tag.setAttribute("name", annotation)

1025

ann_tag.setAttribute("value", value)

1026

if_tag.appendChild(ann_tag)

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)

1027

1539

# Add the names to the return values for the

1028

1540

# "org.freedesktop.DBus.Properties" methods

1029

1541

if (if_tag.getAttribute("name")

1043

1555

document.unlink()

1044

1556

except (AttributeError, xml.dom.DOMException,

1045

1557

xml.parsers.expat.ExpatError) as error:

1046

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

1047

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

1048

1631

return xmlstring

1049

1632

1050

1633

1051

1634

def datetime_to_dbus(dt, variant_level=0):

1052

1635

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

1053

1636

if dt is None:

1054

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

1637

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

1055

1638

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

1056

1639

1057

1640

1060

1643

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

1061

1644

interface names according to the "alt_interface_names" mapping.

1062

1645

Usage:

1063

1646

1064

1647

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

1065

1648

"net.example.AlternateInterface"})

1066

1649

class SampleDBusObject(dbus.service.Object):

1067

1650

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

1068

1651

def SampleDBusMethod():

1069

1652

pass

1070

1653

1071

1654

The above "SampleDBusMethod" on "SampleDBusObject" will be

1072

1655

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

1073

1656

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

1074

1657

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

1075

1658

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

1076

1659

1077

1660

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

1078

1661

(from DBusObjectWithProperties) and interfaces (from the

1079

1662

dbus_interface_annotations decorator).

1080

1663

"""

1081

1664

1082

1665

def wrapper(cls):

1083

1666

for orig_interface_name, alt_interface_name in (

1084

1667

alt_interface_names.items()):

1099

1682

interface_names.add(alt_interface)

1100

1683

# Is this a D-Bus signal?

1101

1684

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

1685

# Extract the original non-method undecorated

1686

# function by black magic

1102

1687

if sys.version_info.major == 2:

1103

# Extract the original non-method undecorated

1104

# function by black magic

1105

1688

nonmethod_func = (dict(

1106

1689

zip(attribute.func_code.co_freevars,

1107

1690

attribute.__closure__))

1108

1691

["func"].cell_contents)

1109

1692

else:

1110

nonmethod_func = attribute

1693

nonmethod_func = (dict(

1694

zip(attribute.__code__.co_freevars,

1695

attribute.__closure__))

1696

["func"].cell_contents)

1111

1697

# Create a new, but exactly alike, function

1112

1698

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

1113

1699

# with the alternate D-Bus interface name

1114

if sys.version_info.major == 2:

1115

new_function = types.FunctionType(

1116

nonmethod_func.func_code,

1117

nonmethod_func.func_globals,

1118

nonmethod_func.func_name,

1119

nonmethod_func.func_defaults,

1120

nonmethod_func.func_closure)

1121

else:

1122

new_function = types.FunctionType(

1123

nonmethod_func.__code__,

1124

nonmethod_func.__globals__,

1125

nonmethod_func.__name__,

1126

nonmethod_func.__defaults__,

1127

nonmethod_func.__closure__)

1700

new_function = copy_function(nonmethod_func)

1128

1701

new_function = (dbus.service.signal(

1129

1702

alt_interface,

1130

1703

attribute._dbus_signature)(new_function))

1134

1707

attribute._dbus_annotations)

1135

1708

except AttributeError:

1136

1709

pass

1710

1137

1711

# Define a creator of a function to call both the

1138

1712

# original and alternate functions, so both the

1139

1713

# original and alternate signals gets sent when

1142

1716

"""This function is a scope container to pass

1143

1717

func1 and func2 to the "call_both" function

1144

1718

outside of its arguments"""

1145

1719

1720

@functools.wraps(func2)

1146

1721

def call_both(*args, **kwargs):

1147

1722

"""This function will emit two D-Bus

1148

1723

signals by calling func1 and func2"""

1149

1724

func1(*args, **kwargs)

1150

1725

func2(*args, **kwargs)

1151

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

1152

1732

return call_both

1153

1733

# Create the "call_both" function and add it to

1154

1734

# the class

1164

1744

alt_interface,

1165

1745

attribute._dbus_in_signature,

1166

1746

attribute._dbus_out_signature)

1167

(types.FunctionType(attribute.func_code,

1168

attribute.func_globals,

1169

attribute.func_name,

1170

attribute.func_defaults,

1171

attribute.func_closure)))

1747

(copy_function(attribute)))

1172

1748

# Copy annotations, if any

1173

1749

try:

1174

1750

attr[attrname]._dbus_annotations = dict(

1186

1762

attribute._dbus_access,

1187

1763

attribute._dbus_get_args_options

1188

1764

["byte_arrays"])

1189

(types.FunctionType(

1190

attribute.func_code,

1191

attribute.func_globals,

1192

attribute.func_name,

1193

attribute.func_defaults,

1194

attribute.func_closure)))

1765

(copy_function(attribute)))

1195

1766

# Copy annotations, if any

1196

1767

try:

1197

1768

attr[attrname]._dbus_annotations = dict(

1206

1777

# to the class.

1207

1778

attr[attrname] = (

1208

1779

dbus_interface_annotations(alt_interface)

1209

(types.FunctionType(attribute.func_code,

1210

attribute.func_globals,

1211

attribute.func_name,

1212

attribute.func_defaults,

1213

attribute.func_closure)))

1780

(copy_function(attribute)))

1214

1781

if deprecate:

1215

1782

# Deprecate all alternate interfaces

1216

iname="_AlternateDBusNames_interface_annotation{}"

1783

iname = "_AlternateDBusNames_interface_annotation{}"

1217

1784

for interface_name in interface_names:

1218

1785

1219

1786

@dbus_interface_annotations(interface_name)

1220

1787

def func(self):

1221

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

1222

"true" }

1788

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

1789

"true"}

1223

1790

# Find an unused name

1224

1791

for aname in (iname.format(i)

1225

1792

for i in itertools.count()):

1229

1796

if interface_names:

1230

1797

# Replace the class with a new subclass of it with

1231

1798

# methods, signals, etc. as created above.

1232

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

1233

(cls, ), attr)

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)

1234

1805

return cls

1235

1806

1236

1807

return wrapper

1237

1808

1238

1809

1240

1811

"se.bsnet.fukt.Mandos"})

1241

1812

class ClientDBus(Client, DBusObjectWithProperties):

1242

1813

"""A Client class using D-Bus

1243

1814

1244

1815

Attributes:

1245

1816

dbus_object_path: dbus.ObjectPath

1246

1817

bus: dbus.SystemBus()

1247

1818

"""

1248

1819

1249

1820

runtime_expansions = (Client.runtime_expansions

1250

1821

+ ("dbus_object_path", ))

1251

1822

1252

1823

_interface = "se.recompile.Mandos.Client"

1253

1824

1254

1825

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

1255

1256

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

1826

1827

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

1257

1828

self.bus = bus

1258

1829

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

1259

1830

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

1265

1836

"/clients/" + client_object_name)

1266

1837

DBusObjectWithProperties.__init__(self, self.bus,

1267

1838

self.dbus_object_path)

1268

1839

1269

1840

def notifychangeproperty(transform_func, dbus_name,

1270

1841

type_func=lambda x: x,

1271

1842

variant_level=1,

1273

1844

_interface=_interface):

1274

1845

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

1275

1846

its changes to DBus.

1276

1847

1277

1848

transform_fun: Function that takes a value and a variant_level

1278

1849

and transforms it to a D-Bus type.

1279

1850

dbus_name: D-Bus name of the variable

1282

1853

variant_level: D-Bus variant level. Default: 1

1283

1854

"""

1284

1855

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

1285

1856

1286

1857

def setter(self, value):

1287

1858

if hasattr(self, "dbus_object_path"):

1288

1859

if (not hasattr(self, attrname) or

1295

1866

else:

1296

1867

dbus_value = transform_func(

1297

1868

type_func(value),

1298

variant_level = variant_level)

1869

variant_level=variant_level)

1299

1870

self.PropertyChanged(dbus.String(dbus_name),

1300

1871

dbus_value)

1301

1872

self.PropertiesChanged(

1302

1873

_interface,

1303

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

1304

dbus_value }),

1874

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

1875

dbus_value}),

1305

1876

dbus.Array())

1306

1877

setattr(self, attrname, value)

1307

1878

1308

1879

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

1309

1880

1310

1881

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1311

1882

approvals_pending = notifychangeproperty(dbus.Boolean,

1312

1883

"ApprovalPending",

1313

type_func = bool)

1884

type_func=bool)

1314

1885

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

1315

1886

last_enabled = notifychangeproperty(datetime_to_dbus,

1316

1887

"LastEnabled")

1317

1888

checker = notifychangeproperty(

1318

1889

dbus.Boolean, "CheckerRunning",

1319

type_func = lambda checker: checker is not None)

1890

type_func=lambda checker: checker is not None)

1320

1891

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1321

1892

"LastCheckedOK")

1322

1893

last_checker_status = notifychangeproperty(dbus.Int16,

1327

1898

"ApprovedByDefault")

1328

1899

approval_delay = notifychangeproperty(

1329

1900

dbus.UInt64, "ApprovalDelay",

1330

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

1901

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

1331

1902

approval_duration = notifychangeproperty(

1332

1903

dbus.UInt64, "ApprovalDuration",

1333

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

1904

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

1334

1905

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

1335

1906

timeout = notifychangeproperty(

1336

1907

dbus.UInt64, "Timeout",

1337

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

1908

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

1338

1909

extended_timeout = notifychangeproperty(

1339

1910

dbus.UInt64, "ExtendedTimeout",

1340

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

1911

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

1341

1912

interval = notifychangeproperty(

1342

1913

dbus.UInt64, "Interval",

1343

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

1914

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

1344

1915

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

1345

1916

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

1346

1917

invalidate_only=True)

1347

1918

1348

1919

del notifychangeproperty

1349

1920

1350

1921

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

1351

1922

try:

1352

1923

self.remove_from_connection()

1355

1926

if hasattr(DBusObjectWithProperties, "__del__"):

1356

1927

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

1357

1928

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

1358

1929

1359

1930

def checker_callback(self, source, condition,

1360

1931

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

1361

1932

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

1365

1936

if exitstatus >= 0:

1366

1937

# Emit D-Bus signal

1367

1938

self.CheckerCompleted(dbus.Int16(exitstatus),

1368

dbus.Int64(0),

1939

# This is specific to GNU libC

1940

dbus.Int64(exitstatus << 8),

1369

1941

dbus.String(command))

1370

1942

else:

1371

1943

# Emit D-Bus signal

1372

1944

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

1373

1945

dbus.Int64(

1374

self.last_checker_signal),

1946

# This is specific to GNU libC

1947

(exitstatus << 8)

1948

| self.last_checker_signal),

1375

1949

dbus.String(command))

1376

1950

return ret

1377

1951

1378

1952

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

1379

1953

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

1380

1954

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

1384

1958

# Emit D-Bus signal

1385

1959

self.CheckerStarted(self.current_checker_command)

1386

1960

return r

1387

1961

1388

1962

def _reset_approved(self):

1389

1963

self.approved = None

1390

1964

return False

1391

1965

1392

1966

def approve(self, value=True):

1393

1967

self.approved = value

1394

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

1395

* 1000), self._reset_approved)

1968

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

1969

* 1000), self._reset_approved)

1396

1970

self.send_changedstate()

1397

1398

## D-Bus methods, signals & properties

1399

1400

## Interfaces

1401

1402

## Signals

1403

1971

1972

# D-Bus methods, signals & properties

1973

1974

# Interfaces

1975

1976

# Signals

1977

1404

1978

# CheckerCompleted - signal

1405

1979

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

1406

1980

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

1407

1981

"D-Bus signal"

1408

1982

pass

1409

1983

1410

1984

# CheckerStarted - signal

1411

1985

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

1412

1986

def CheckerStarted(self, command):

1413

1987

"D-Bus signal"

1414

1988

pass

1415

1989

1416

1990

# PropertyChanged - signal

1417

1991

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

1418

1992

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

1419

1993

def PropertyChanged(self, property, value):

1420

1994

"D-Bus signal"

1421

1995

pass

1422

1996

1423

1997

# GotSecret - signal

1424

1998

@dbus.service.signal(_interface)

1425

1999

def GotSecret(self):

1428

2002

server to mandos-client

1429

2003

"""

1430

2004

pass

1431

2005

1432

2006

# Rejected - signal

1433

2007

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

1434

2008

def Rejected(self, reason):

1435

2009

"D-Bus signal"

1436

2010

pass

1437

2011

1438

2012

# NeedApproval - signal

1439

2013

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

1440

2014

def NeedApproval(self, timeout, default):

1441

2015

"D-Bus signal"

1442

2016

return self.need_approval()

1443

1444

## Methods

1445

2017

2018

# Methods

2019

1446

2020

# Approve - method

1447

2021

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

1448

2022

def Approve(self, value):

1449

2023

self.approve(value)

1450

2024

1451

2025

# CheckedOK - method

1452

2026

@dbus.service.method(_interface)

1453

2027

def CheckedOK(self):

1454

2028

self.checked_ok()

1455

2029

1456

2030

# Enable - method

2031

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

1457

2032

@dbus.service.method(_interface)

1458

2033

def Enable(self):

1459

2034

"D-Bus method"

1460

2035

self.enable()

1461

2036

1462

2037

# StartChecker - method

2038

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

1463

2039

@dbus.service.method(_interface)

1464

2040

def StartChecker(self):

1465

2041

"D-Bus method"

1466

2042

self.start_checker()

1467

2043

1468

2044

# Disable - method

2045

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

1469

2046

@dbus.service.method(_interface)

1470

2047

def Disable(self):

1471

2048

"D-Bus method"

1472

2049

self.disable()

1473

2050

1474

2051

# StopChecker - method

2052

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

1475

2053

@dbus.service.method(_interface)

1476

2054

def StopChecker(self):

1477

2055

self.stop_checker()

1478

1479

## Properties

1480

2056

2057

# Properties

2058

1481

2059

# ApprovalPending - property

1482

2060

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

1483

2061

def ApprovalPending_dbus_property(self):

1484

2062

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

1485

2063

1486

2064

# ApprovedByDefault - property

1487

2065

@dbus_service_property(_interface,

1488

2066

signature="b",

1491

2069

if value is None: # get

1492

2070

return dbus.Boolean(self.approved_by_default)

1493

2071

self.approved_by_default = bool(value)

1494

2072

1495

2073

# ApprovalDelay - property

1496

2074

@dbus_service_property(_interface,

1497

2075

signature="t",

1501

2079

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

1502

2080

* 1000)

1503

2081

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

1504

2082

1505

2083

# ApprovalDuration - property

1506

2084

@dbus_service_property(_interface,

1507

2085

signature="t",

1511

2089

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

1512

2090

* 1000)

1513

2091

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

1514

2092

1515

2093

# Name - property

2094

@dbus_annotations(

2095

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

1516

2096

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

1517

2097

def Name_dbus_property(self):

1518

2098

return dbus.String(self.name)

1519

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

1520

2107

# Fingerprint - property

2108

@dbus_annotations(

2109

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

1521

2110

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

1522

2111

def Fingerprint_dbus_property(self):

1523

2112

return dbus.String(self.fingerprint)

1524

2113

1525

2114

# Host - property

1526

2115

@dbus_service_property(_interface,

1527

2116

signature="s",

1530

2119

if value is None: # get

1531

2120

return dbus.String(self.host)

1532

2121

self.host = str(value)

1533

2122

1534

2123

# Created - property

2124

@dbus_annotations(

2125

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

1535

2126

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

1536

2127

def Created_dbus_property(self):

1537

2128

return datetime_to_dbus(self.created)

1538

2129

1539

2130

# LastEnabled - property

1540

2131

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

1541

2132

def LastEnabled_dbus_property(self):

1542

2133

return datetime_to_dbus(self.last_enabled)

1543

2134

1544

2135

# Enabled - property

1545

2136

@dbus_service_property(_interface,

1546

2137

signature="b",

1552

2143

self.enable()

1553

2144

else:

1554

2145

self.disable()

1555

2146

1556

2147

# LastCheckedOK - property

1557

2148

@dbus_service_property(_interface,

1558

2149

signature="s",

1562

2153

self.checked_ok()

1563

2154

return

1564

2155

return datetime_to_dbus(self.last_checked_ok)

1565

2156

1566

2157

# LastCheckerStatus - property

1567

2158

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

1568

2159

def LastCheckerStatus_dbus_property(self):

1569

2160

return dbus.Int16(self.last_checker_status)

1570

2161

1571

2162

# Expires - property

1572

2163

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

1573

2164

def Expires_dbus_property(self):

1574

2165

return datetime_to_dbus(self.expires)

1575

2166

1576

2167

# LastApprovalRequest - property

1577

2168

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

1578

2169

def LastApprovalRequest_dbus_property(self):

1579

2170

return datetime_to_dbus(self.last_approval_request)

1580

2171

1581

2172

# Timeout - property

1582

2173

@dbus_service_property(_interface,

1583

2174

signature="t",

1598

2189

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

1599

2190

is None):

1600

2191

return

1601

gobject.source_remove(self.disable_initiator_tag)

1602

self.disable_initiator_tag = gobject.timeout_add(

2192

GLib.source_remove(self.disable_initiator_tag)

2193

self.disable_initiator_tag = GLib.timeout_add(

1603

2194

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

1604

2195

self.disable)

1605

2196

1606

2197

# ExtendedTimeout - property

1607

2198

@dbus_service_property(_interface,

1608

2199

signature="t",

1612

2203

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

1613

2204

* 1000)

1614

2205

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

1615

2206

1616

2207

# Interval - property

1617

2208

@dbus_service_property(_interface,

1618

2209

signature="t",

1625

2216

return

1626

2217

if self.enabled:

1627

2218

# Reschedule checker run

1628

gobject.source_remove(self.checker_initiator_tag)

1629

self.checker_initiator_tag = gobject.timeout_add(

2219

GLib.source_remove(self.checker_initiator_tag)

2220

self.checker_initiator_tag = GLib.timeout_add(

1630

2221

value, self.start_checker)

1631

self.start_checker() # Start one now, too

1632

2222

self.start_checker() # Start one now, too

2223

1633

2224

# Checker - property

1634

2225

@dbus_service_property(_interface,

1635

2226

signature="s",

1638

2229

if value is None: # get

1639

2230

return dbus.String(self.checker_command)

1640

2231

self.checker_command = str(value)

1641

2232

1642

2233

# CheckerRunning - property

1643

2234

@dbus_service_property(_interface,

1644

2235

signature="b",

1650

2241

self.start_checker()

1651

2242

else:

1652

2243

self.stop_checker()

1653

2244

1654

2245

# ObjectPath - property

2246

@dbus_annotations(

2247

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

2248

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

1655

2249

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

1656

2250

def ObjectPath_dbus_property(self):

1657

return self.dbus_object_path # is already a dbus.ObjectPath

1658

2251

return self.dbus_object_path # is already a dbus.ObjectPath

2252

1659

2253

# Secret = property

2254

@dbus_annotations(

2255

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

2256

"invalidates"})

1660

2257

@dbus_service_property(_interface,

1661

2258

signature="ay",

1662

2259

access="write",

1663

2260

byte_arrays=True)

1664

2261

def Secret_dbus_property(self, value):

1665

2262

self.secret = bytes(value)

1666

2263

1667

2264

del _interface

1668

2265

1669

2266

1670

class ProxyClient(object):

1671

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

2267

class ProxyClient:

2268

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

1672

2269

self._pipe = child_pipe

1673

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

2270

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

1674

2271

if not self._pipe.recv():

1675

raise KeyError(fpr)

1676

2272

raise KeyError(key_id or fpr)

2273

1677

2274

def __getattribute__(self, name):

1678

if name == '_pipe':

2275

if name == "_pipe":

1679

2276

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

1680

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

2277

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

1681

2278

data = self._pipe.recv()

1682

if data[0] == 'data':

2279

if data[0] == "data":

1683

2280

return data[1]

1684

if data[0] == 'function':

1685

2281

if data[0] == "function":

2282

1686

2283

def func(*args, **kwargs):

1687

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

2284

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

1688

2285

return self._pipe.recv()[1]

1689

2286

1690

2287

return func

1691

2288

1692

2289

def __setattr__(self, name, value):

1693

if name == '_pipe':

2290

if name == "_pipe":

1694

2291

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

1695

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

2292

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

1696

2293

1697

2294

1698

2295

class ClientHandler(socketserver.BaseRequestHandler, object):

1699

2296

"""A class to handle client connections.

1700

2297

1701

2298

Instantiated once for each connection to handle it.

1702

2299

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

1703

2300

1704

2301

def handle(self):

1705

2302

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

1706

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

1707

str(self.client_address))

1708

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

1709

self.server.child_pipe.fileno())

1710

1711

session = gnutls.connection.ClientSession(

1712

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

1713

1714

# Note: gnutls.connection.X509Credentials is really a

1715

# generic GnuTLS certificate credentials object so long as

1716

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

1717

# here despite using OpenPGP certificates.

1718

1719

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

1720

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

1721

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

1722

# "+DHE-DSS"))

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

1723

2313

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

1724

2314

priority = self.server.gnutls_priority

1725

2315

if priority is None:

1726

2316

priority = "NORMAL"

1727

gnutls.library.functions.gnutls_priority_set_direct(

1728

session._c_object, priority, None)

1729

2317

gnutls.priority_set_direct(session,

2318

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

2319

1730

2320

# Start communication using the Mandos protocol

1731

2321

# Get protocol number

1732

2322

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

1733

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

2323

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

1734

2324

try:

1735

2325

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

1736

2326

raise RuntimeError(line)

1737

2327

except (ValueError, IndexError, RuntimeError) as error:

1738

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

2328

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

1739

2329

return

1740

2330

1741

2331

# Start GnuTLS connection

1742

2332

try:

1743

2333

session.handshake()

1744

except gnutls.errors.GNUTLSError as error:

1745

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

2334

except gnutls.Error as error:

2335

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

1746

2336

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

1747

2337

# established. Just abandon the request.

1748

2338

return

1749

logger.debug("Handshake succeeded")

1750

2339

log.debug("Handshake succeeded")

2340

1751

2341

approval_required = False

1752

2342

try:

1753

try:

1754

fpr = self.fingerprint(

1755

self.peer_certificate(session))

1756

except (TypeError,

1757

gnutls.errors.GNUTLSError) as error:

1758

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

1759

return

1760

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

1761

1762

try:

1763

client = ProxyClient(child_pipe, fpr,

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,

1764

2367

self.client_address)

1765

2368

except KeyError:

1766

2369

return

1767

2370

1768

2371

if client.approval_delay:

1769

2372

delay = client.approval_delay

1770

2373

client.approvals_pending += 1

1771

2374

approval_required = True

1772

2375

1773

2376

while True:

1774

2377

if not client.enabled:

1775

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

1776

client.name)

2378

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

1777

2379

if self.server.use_dbus:

1778

2380

# Emit D-Bus signal

1779

2381

client.Rejected("Disabled")

1780

2382

return

1781

2383

1782

2384

if client.approved or not client.approval_delay:

1783

#We are approved or approval is disabled

2385

# We are approved or approval is disabled

1784

2386

break

1785

2387

elif client.approved is None:

1786

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

1787

client.name)

2388

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

2389

client.name)

1788

2390

if self.server.use_dbus:

1789

2391

# Emit D-Bus signal

1790

2392

client.NeedApproval(

1791

2393

client.approval_delay.total_seconds()

1792

2394

* 1000, client.approved_by_default)

1793

2395

else:

1794

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

1795

client.name)

2396

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

2397

client.name)

1796

2398

if self.server.use_dbus:

1797

2399

# Emit D-Bus signal

1798

2400

client.Rejected("Denied")

1799

2401

return

1800

1801

#wait until timeout or approved

2402

2403

# wait until timeout or approved

1802

2404

time = datetime.datetime.now()

1803

2405

client.changedstate.acquire()

1804

2406

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

1806

2408

time2 = datetime.datetime.now()

1807

2409

if (time2 - time) >= delay:

1808

2410

if not client.approved_by_default:

1809

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

1810

" waiting for approval",

1811

client.name)

2411

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

2412

" waiting for approval",

2413

client.name)

1812

2414

if self.server.use_dbus:

1813

2415

# Emit D-Bus signal

1814

2416

client.Rejected("Approval timed out")

1817

2419

break

1818

2420

else:

1819

2421

delay -= time2 - time

1820

1821

sent_size = 0

1822

while sent_size < len(client.secret):

1823

try:

1824

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

1825

except gnutls.errors.GNUTLSError as error:

1826

logger.warning("gnutls send failed",

1827

exc_info=error)

1828

return

1829

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

1830

len(client.secret) - (sent_size

1831

+ sent))

1832

sent_size += sent

1833

1834

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

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)

1835

2430

# bump the timeout using extended_timeout

1836

2431

client.bump_timeout(client.extended_timeout)

1837

2432

if self.server.use_dbus:

1838

2433

# Emit D-Bus signal

1839

2434

client.GotSecret()

1840

2435

1841

2436

finally:

1842

2437

if approval_required:

1843

2438

client.approvals_pending -= 1

1844

2439

try:

1845

2440

session.bye()

1846

except gnutls.errors.GNUTLSError as error:

1847

logger.warning("GnuTLS bye failed",

1848

exc_info=error)

1849

2441

except gnutls.Error as error:

2442

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

2443

1850

2444

@staticmethod

1851

2445

def peer_certificate(session):

1852

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

1853

# If not an OpenPGP certificate...

1854

if (gnutls.library.functions.gnutls_certificate_type_get(

1855

session._c_object)

1856

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1857

# ...do the normal thing

1858

return session.peer_certificate

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

1859

2462

list_size = ctypes.c_uint(1)

1860

cert_list = (gnutls.library.functions

1861

.gnutls_certificate_get_peers

1862

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

2463

cert_list = (gnutls.certificate_get_peers

2464

(session, ctypes.byref(list_size)))

1863

2465

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

1864

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

1865

" certificate")

2466

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

1866

2467

if list_size.value == 0:

1867

2468

return None

1868

2469

cert = cert_list[0]

1869

2470

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

1870

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

1871

2507

@staticmethod

1872

2508

def fingerprint(openpgp):

1873

2509

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1874

2510

# New GnuTLS "datum" with the OpenPGP public key

1875

datum = gnutls.library.types.gnutls_datum_t(

2511

datum = gnutls.datum_t(

1876

2512

ctypes.cast(ctypes.c_char_p(openpgp),

1877

2513

ctypes.POINTER(ctypes.c_ubyte)),

1878

2514

ctypes.c_uint(len(openpgp)))

1879

2515

# New empty GnuTLS certificate

1880

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1881

gnutls.library.functions.gnutls_openpgp_crt_init(

1882

ctypes.byref(crt))

2516

crt = gnutls.openpgp_crt_t()

2517

gnutls.openpgp_crt_init(ctypes.byref(crt))

1883

2518

# Import the OpenPGP public key into the certificate

1884

gnutls.library.functions.gnutls_openpgp_crt_import(

1885

crt, ctypes.byref(datum),

1886

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

2519

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

2520

gnutls.OPENPGP_FMT_RAW)

1887

2521

# Verify the self signature in the key

1888

2522

crtverify = ctypes.c_uint()

1889

gnutls.library.functions.gnutls_openpgp_crt_verify_self(

1890

crt, 0, ctypes.byref(crtverify))

2523

gnutls.openpgp_crt_verify_self(crt, 0,

2524

ctypes.byref(crtverify))

1891

2525

if crtverify.value != 0:

1892

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1893

raise gnutls.errors.CertificateSecurityError(

1894

"Verify failed")

2526

gnutls.openpgp_crt_deinit(crt)

2527

raise gnutls.CertificateSecurityError(code

2528

=crtverify.value)

1895

2529

# New buffer for the fingerprint

1896

2530

buf = ctypes.create_string_buffer(20)

1897

2531

buf_len = ctypes.c_size_t()

1898

2532

# Get the fingerprint from the certificate into the buffer

1899

gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(

1900

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

2533

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

2534

ctypes.byref(buf_len))

1901

2535

# Deinit the certificate

1902

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2536

gnutls.openpgp_crt_deinit(crt)

1903

2537

# Convert the buffer to a Python bytestring

1904

2538

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

1905

2539

# Convert the bytestring to hexadecimal notation

1907

2541

return hex_fpr

1908

2542

1909

2543

1910

class MultiprocessingMixIn(object):

2544

class MultiprocessingMixIn:

1911

2545

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

1912

2546

1913

2547

def sub_process_main(self, request, address):

1914

2548

try:

1915

2549

self.finish_request(request, address)

1916

2550

except Exception:

1917

2551

self.handle_error(request, address)

1918

2552

self.close_request(request)

1919

2553

1920

2554

def process_request(self, request, address):

1921

2555

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

1922

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

1923

args = (request, address))

2556

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

2557

args=(request, address))

1924

2558

proc.start()

1925

2559

return proc

1926

2560

1927

2561

1928

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2562

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1929

2563

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

1930

2564

1931

2565

def process_request(self, request, client_address):

1932

2566

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

1933

2567

1934

2568

This function creates a new pipe in self.pipe

1935

2569

"""

1936

2570

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1937

2571

1938

2572

proc = MultiprocessingMixIn.process_request(self, request,

1939

2573

client_address)

1940

2574

self.child_pipe.close()

1941

2575

self.add_pipe(parent_pipe, proc)

1942

2576

1943

2577

def add_pipe(self, parent_pipe, proc):

1944

2578

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

1945

2579

raise NotImplementedError()

1946

2580

1947

2581

1948

2582

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1949

socketserver.TCPServer, object):

1950

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

1951

2583

socketserver.TCPServer):

2584

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

2585

1952

2586

Attributes:

1953

2587

enabled: Boolean; whether this server is activated yet

1954

2588

interface: None or a network interface name (string)

1955

2589

use_ipv6: Boolean; to use IPv6 or not

1956

2590

"""

1957

2591

1958

2592

def __init__(self, server_address, RequestHandlerClass,

1959

2593

interface=None,

1960

2594

use_ipv6=True,

1970

2604

self.socketfd = socketfd

1971

2605

# Save the original socket.socket() function

1972

2606

self.socket_socket = socket.socket

2607

1973

2608

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

1974

#

2609

#

1975

2610

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

1976

2611

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

1977

2612

# patching socket.socket.)

1978

#

2613

#

1979

2614

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

1980

2615

@functools.wraps(socket.socket)

1981

2616

def socket_wrapper(*args, **kwargs):

1993

2628

# socket_wrapper(), if socketfd was set.

1994

2629

socketserver.TCPServer.__init__(self, server_address,

1995

2630

RequestHandlerClass)

1996

2631

1997

2632

def server_bind(self):

1998

2633

"""This overrides the normal server_bind() function

1999

2634

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

2000

2635

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

2636

global SO_BINDTODEVICE

2001

2637

if self.interface is not None:

2002

2638

if SO_BINDTODEVICE is None:

2003

logger.error("SO_BINDTODEVICE does not exist;"

2004

" cannot bind to interface %s",

2005

self.interface)

2006

else:

2007

try:

2008

self.socket.setsockopt(

2009

socket.SOL_SOCKET, SO_BINDTODEVICE,

2010

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

2011

except socket.error as error:

2012

if error.errno == errno.EPERM:

2013

logger.error("No permission to bind to"

2014

" interface %s", self.interface)

2015

elif error.errno == errno.ENOPROTOOPT:

2016

logger.error("SO_BINDTODEVICE not available;"

2017

" cannot bind to interface %s",

2018

self.interface)

2019

elif error.errno == errno.ENODEV:

2020

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

2021

" cannot bind", self.interface)

2022

else:

2023

raise

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

2024

2659

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

2025

2660

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

2661

if self.server_address[1]:

2662

self.allow_reuse_address = True

2026

2663

if not self.server_address[0]:

2027

2664

if self.address_family == socket.AF_INET6:

2028

any_address = "::" # in6addr_any

2665

any_address = "::" # in6addr_any

2029

2666

else:

2030

any_address = "0.0.0.0" # INADDR_ANY

2667

any_address = "0.0.0.0" # INADDR_ANY

2031

2668

self.server_address = (any_address,

2032

2669

self.server_address[1])

2033

2670

elif not self.server_address[1]:

2043

2680

2044

2681

class MandosServer(IPv6_TCPServer):

2045

2682

"""Mandos server.

2046

2683

2047

2684

Attributes:

2048

2685

clients: set of Client objects

2049

2686

gnutls_priority GnuTLS priority string

2050

2687

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

2051

2052

Assumes a gobject.MainLoop event loop.

2688

2689

Assumes a GLib.MainLoop event loop.

2053

2690

"""

2054

2691

2055

2692

def __init__(self, server_address, RequestHandlerClass,

2056

2693

interface=None,

2057

2694

use_ipv6=True,

2067

2704

self.gnutls_priority = gnutls_priority

2068

2705

IPv6_TCPServer.__init__(self, server_address,

2069

2706

RequestHandlerClass,

2070

interface = interface,

2071

use_ipv6 = use_ipv6,

2072

socketfd = socketfd)

2073

2707

interface=interface,

2708

use_ipv6=use_ipv6,

2709

socketfd=socketfd)

2710

2074

2711

def server_activate(self):

2075

2712

if self.enabled:

2076

2713

return socketserver.TCPServer.server_activate(self)

2077

2714

2078

2715

def enable(self):

2079

2716

self.enabled = True

2080

2717

2081

2718

def add_pipe(self, parent_pipe, proc):

2082

2719

# Call "handle_ipc" for both data and EOF events

2083

gobject.io_add_watch(

2084

parent_pipe.fileno(),

2085

gobject.IO_IN | gobject.IO_HUP,

2720

GLib.io_add_watch(

2721

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

2722

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

2086

2723

functools.partial(self.handle_ipc,

2087

parent_pipe = parent_pipe,

2088

proc = proc))

2089

2724

parent_pipe=parent_pipe,

2725

proc=proc))

2726

2090

2727

def handle_ipc(self, source, condition,

2091

2728

parent_pipe=None,

2092

proc = None,

2729

proc=None,

2093

2730

client_object=None):

2094

2731

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

2095

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

2732

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

2096

2733

# Wait for other process to exit

2097

2734

proc.join()

2098

2735

return False

2099

2736

2100

2737

# Read a request from the child

2101

2738

request = parent_pipe.recv()

2102

2739

command = request[0]

2103

2104

if command == 'init':

2105

fpr = request[1]

2106

address = request[2]

2107

2108

for c in self.clients.itervalues():

2109

if c.fingerprint == fpr:

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:

2110

2754

client = c

2111

2755

break

2112

2756

else:

2113

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

2114

"dress: %s", fpr, address)

2757

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

2758

" %s", key_id or fpr, address)

2115

2759

if self.use_dbus:

2116

2760

# Emit D-Bus signal

2117

mandos_dbus_service.ClientNotFound(fpr,

2761

mandos_dbus_service.ClientNotFound(key_id or fpr,

2118

2762

address[0])

2119

2763

parent_pipe.send(False)

2120

2764

return False

2121

2122

gobject.io_add_watch(

2123

parent_pipe.fileno(),

2124

gobject.IO_IN | gobject.IO_HUP,

2765

2766

GLib.io_add_watch(

2767

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

2768

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

2125

2769

functools.partial(self.handle_ipc,

2126

parent_pipe = parent_pipe,

2127

proc = proc,

2128

client_object = client))

2770

parent_pipe=parent_pipe,

2771

proc=proc,

2772

client_object=client))

2129

2773

parent_pipe.send(True)

2130

2774

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

2131

2775

# same fileno

2132

2776

return False

2133

if command == 'funcall':

2777

if command == "funcall":

2134

2778

funcname = request[1]

2135

2779

args = request[2]

2136

2780

kwargs = request[3]

2137

2138

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

2781

2782

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

2139

2783

funcname)(*args,

2140

2784

**kwargs)))

2141

2142

if command == 'getattr':

2785

2786

if command == "getattr":

2143

2787

attrname = request[1]

2144

2788

if isinstance(client_object.__getattribute__(attrname),

2145

collections.Callable):

2146

parent_pipe.send(('function', ))

2789

collections.abc.Callable):

2790

parent_pipe.send(("function", ))

2147

2791

else:

2148

2792

parent_pipe.send((

2149

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

2150

2151

if command == 'setattr':

2793

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

2794

2795

if command == "setattr":

2152

2796

attrname = request[1]

2153

2797

value = request[2]

2154

2798

setattr(client_object, attrname, value)

2155

2799

2156

2800

return True

2157

2801

2158

2802

2159

2803

def rfc3339_duration_to_delta(duration):

2160

2804

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

2161

2162

>>> rfc3339_duration_to_delta("P7D")

2163

datetime.timedelta(7)

2164

>>> rfc3339_duration_to_delta("PT60S")

2165

datetime.timedelta(0, 60)

2166

>>> rfc3339_duration_to_delta("PT60M")

2167

datetime.timedelta(0, 3600)

2168

>>> rfc3339_duration_to_delta("PT24H")

2169

datetime.timedelta(1)

2170

>>> rfc3339_duration_to_delta("P1W")

2171

datetime.timedelta(7)

2172

>>> rfc3339_duration_to_delta("PT5M30S")

2173

datetime.timedelta(0, 330)

2174

>>> rfc3339_duration_to_delta("P1DT3M20S")

2175

datetime.timedelta(1, 200)

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

2176

2822

"""

2177

2823

2178

2824

# Parsing an RFC 3339 duration with regular expressions is not

2179

2825

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

2180

2826

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

2181

2827

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

2182

2828

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

2183

2829

# avoid excessive use of external libraries.

2184

2830

2185

2831

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

2186

2832

Token = collections.namedtuple("Token", (

2187

2833

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

2220

2866

frozenset((token_year, token_month,

2221

2867

token_day, token_time,

2222

2868

token_week)))

2223

# Define starting values

2224

value = datetime.timedelta() # Value so far

2869

# Define starting values:

2870

# Value so far

2871

value = datetime.timedelta()

2225

2872

found_token = None

2226

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

2227

s = duration # String left to parse

2873

# Following valid tokens

2874

followers = frozenset((token_duration, ))

2875

# String left to parse

2876

s = duration

2228

2877

# Loop until end token is found

2229

2878

while found_token is not token_end:

2230

2879

# Search for any currently valid tokens

2254

2903

2255

2904

def string_to_delta(interval):

2256

2905

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

2257

2258

>>> string_to_delta('7d')

2259

datetime.timedelta(7)

2260

>>> string_to_delta('60s')

2261

datetime.timedelta(0, 60)

2262

>>> string_to_delta('60m')

2263

datetime.timedelta(0, 3600)

2264

>>> string_to_delta('24h')

2265

datetime.timedelta(1)

2266

>>> string_to_delta('1w')

2267

datetime.timedelta(7)

2268

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

2269

datetime.timedelta(0, 330)

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

2270

2919

"""

2271

2920

2272

2921

try:

2273

2922

return rfc3339_duration_to_delta(interval)

2274

2923

except ValueError:

2275

2924

pass

2276

2925

2277

2926

timevalue = datetime.timedelta(0)

2278

2927

for s in interval.split():

2279

2928

try:

2297

2946

return timevalue

2298

2947

2299

2948

2300

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

2949

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

2301

2950

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

2302

2951

2303

2952

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

2304

2953

if os.fork():

2305

2954

sys.exit()

2323

2972

2324

2973

2325

2974

def main():

2326

2975

2327

2976

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

2328

2977

# Parsing of options, both command line and config file

2329

2978

2330

2979

parser = argparse.ArgumentParser()

2331

2980

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

2332

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

2981

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

2333

2982

help="show version number and exit")

2334

2983

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

2335

2984

help="Bind to interface IF")

2371

3020

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

2372

3021

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

2373

3022

default=None)

2374

3023

2375

3024

options = parser.parse_args()

2376

2377

if options.check:

2378

import doctest

2379

fail_count, test_count = doctest.testmod()

2380

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

2381

3025

2382

3026

# Default values for config file for server-global settings

2383

server_defaults = { "interface": "",

2384

"address": "",

2385

"port": "",

2386

"debug": "False",

2387

"priority":

2388

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

2389

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

2390

"servicename": "Mandos",

2391

"use_dbus": "True",

2392

"use_ipv6": "True",

2393

"debuglevel": "",

2394

"restore": "True",

2395

"socket": "",

2396

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

2397

"foreground": "False",

2398

"zeroconf": "True",

2399

}

2400

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

2401

3050

# Parse config file for server-global settings

2402

server_config = configparser.SafeConfigParser(server_defaults)

3051

server_config = configparser.ConfigParser(server_defaults)

2403

3052

del server_defaults

2404

3053

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

2405

# Convert the SafeConfigParser object to a dict

3054

# Convert the ConfigParser object to a dict

2406

3055

server_settings = server_config.defaults()

2407

3056

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

2408

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

3057

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

3058

"foreground", "zeroconf"):

2409

3059

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

2410

3060

option)

2411

3061

if server_settings["port"]:

2421

3071

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

2422

3072

["socket"])

2423

3073

del server_config

2424

3074

2425

3075

# Override the settings from the config file with command line

2426

3076

# options, if set.

2427

3077

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

2445

3095

if server_settings["debug"]:

2446

3096

server_settings["foreground"] = True

2447

3097

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

2448

3098

2449

3099

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

2450

3100

2451

3101

if (not server_settings["zeroconf"]

2452

3102

and not (server_settings["port"]

2453

3103

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

2454

3104

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

2455

3105

2456

3106

# For convenience

2457

3107

debug = server_settings["debug"]

2458

3108

debuglevel = server_settings["debuglevel"]

2462

3112

stored_state_file)

2463

3113

foreground = server_settings["foreground"]

2464

3114

zeroconf = server_settings["zeroconf"]

2465

3115

2466

3116

if debug:

2467

3117

initlogger(debug, logging.DEBUG)

2468

3118

else:

2471

3121

else:

2472

3122

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

2473

3123

initlogger(debug, level)

2474

3124

2475

3125

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

2476

3126

syslogger.setFormatter(

2477

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

2478

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

3127

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

3128

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

2479

3129

server_settings["servicename"])))

2480

3130

2481

3131

# Parse config file with clients

2482

client_config = configparser.SafeConfigParser(Client

2483

.client_defaults)

3132

client_config = configparser.ConfigParser(Client.client_defaults)

2484

3133

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

2485

3134

"clients.conf"))

2486

3135

2487

3136

global mandos_dbus_service

2488

3137

mandos_dbus_service = None

2489

3138

2490

3139

socketfd = None

2491

3140

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

2492

3141

socketfd = server_settings["socket"]

2506

3155

try:

2507

3156

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

2508

3157

except IOError as e:

2509

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

2510

exc_info=e)

2511

2512

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

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

2513

3164

try:

2514

3165

uid = pwd.getpwnam(name).pw_uid

2515

gid = pwd.getpwnam(name).pw_gid

3166

gid = pwd.getpwnam(group).pw_gid

2516

3167

break

2517

3168

except KeyError:

2518

3169

continue

2522

3173

try:

2523

3174

os.setgid(gid)

2524

3175

os.setuid(uid)

3176

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

2525

3177

except OSError as error:

3178

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

3179

os.strerror(error.errno))

2526

3180

if error.errno != errno.EPERM:

2527

3181

raise

2528

3182

2529

3183

if debug:

2530

3184

# Enable all possible GnuTLS debugging

2531

3185

2532

3186

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

2533

3187

# - GnuTLS manual

2534

gnutls.library.functions.gnutls_global_set_log_level(11)

2535

2536

@gnutls.library.types.gnutls_log_func

3188

gnutls.global_set_log_level(11)

3189

3190

@gnutls.log_func

2537

3191

def debug_gnutls(level, string):

2538

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

2539

2540

gnutls.library.functions.gnutls_global_set_log_function(

2541

debug_gnutls)

2542

3192

log.debug("GnuTLS: %s",

3193

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

3194

3195

gnutls.global_set_log_function(debug_gnutls)

3196

2543

3197

# Redirect stdin so all checkers get /dev/null

2544

3198

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

2545

3199

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

2546

3200

if null > 2:

2547

3201

os.close(null)

2548

3202

2549

3203

# Need to fork before connecting to D-Bus

2550

3204

if not foreground:

2551

3205

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

2552

3206

daemon()

2553

2554

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

2555

# need to inform gobject that threads will be used.

2556

gobject.threads_init()

2557

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

2558

3213

global main_loop

2559

3214

# From the Avahi example code

2560

3215

DBusGMainLoop(set_as_default=True)

2561

main_loop = gobject.MainLoop()

3216

main_loop = GLib.MainLoop()

2562

3217

bus = dbus.SystemBus()

2563

3218

# End of Avahi example code

2564

3219

if use_dbus:

2570

3225

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

2571

3226

do_not_queue=True)

2572

3227

except dbus.exceptions.DBusException as e:

2573

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

3228

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

2574

3229

use_dbus = False

2575

3230

server_settings["use_dbus"] = False

2576

3231

tcp_server.use_dbus = False

2577

3232

if zeroconf:

2578

3233

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2579

3234

service = AvahiServiceToSyslog(

2580

name = server_settings["servicename"],

2581

servicetype = "_mandos._tcp",

2582

protocol = protocol,

2583

bus = bus)

3235

name=server_settings["servicename"],

3236

servicetype="_mandos._tcp",

3237

protocol=protocol,

3238

bus=bus)

2584

3239

if server_settings["interface"]:

2585

3240

service.interface = if_nametoindex(

2586

3241

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

2587

3242

2588

3243

global multiprocessing_manager

2589

3244

multiprocessing_manager = multiprocessing.Manager()

2590

3245

2591

3246

client_class = Client

2592

3247

if use_dbus:

2593

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

2594

3248

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

3249

2595

3250

client_settings = Client.config_parser(client_config)

2596

3251

old_client_settings = {}

2597

3252

clients_data = {}

2598

3253

2599

3254

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

2600

3255

global wnull

2601

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

3256

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

2602

3257

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

2603

3258

# mode

2604

3259

if debug or not foreground:

2605

3260

wnull.close()

2606

3261

2607

3262

# Get client data and settings from last running state.

2608

3263

if server_settings["restore"]:

2609

3264

try:

2610

3265

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

2611

clients_data, old_client_settings = pickle.load(

2612

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

2613

3316

os.remove(stored_state_path)

2614

3317

except IOError as e:

2615

3318

if e.errno == errno.ENOENT:

2616

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

2617

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

3319

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

3320

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

2618

3321

else:

2619

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

2620

exc_info=e)

3322

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

3323

exc_info=e)

2621

3324

raise

2622

3325

except EOFError as e:

2623

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

2624

"EOFError:",

2625

exc_info=e)

2626

3326

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

3327

exc_info=e)

3328

2627

3329

with PGPEngine() as pgp:

2628

3330

for client_name, client in clients_data.items():

2629

3331

# Skip removed clients

2630

3332

if client_name not in client_settings:

2631

3333

continue

2632

3334

2633

3335

# Decide which value to use after restoring saved state.

2634

3336

# We have three different values: Old config file,

2635

3337

# new config file, and saved state.

2646

3348

client[name] = value

2647

3349

except KeyError:

2648

3350

pass

2649

3351

2650

3352

# Clients who has passed its expire date can still be

2651

3353

# enabled if its last checker was successful. A Client

2652

3354

# whose checker succeeded before we stored its state is

2655

3357

if client["enabled"]:

2656

3358

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

2657

3359

if not client["last_checked_ok"]:

2658

logger.warning(

2659

"disabling client {} - Client never "

2660

"performed a successful checker".format(

2661

client_name))

3360

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

3361

" never performed a successful"

3362

" checker", client_name)

2662

3363

client["enabled"] = False

2663

3364

elif client["last_checker_status"] != 0:

2664

logger.warning(

2665

"disabling client {} - Client last"

2666

" checker failed with error code"

2667

" {}".format(

2668

client_name,

2669

client["last_checker_status"]))

3365

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

3366

" last checker failed with error"

3367

" code %s", client_name,

3368

client["last_checker_status"])

2670

3369

client["enabled"] = False

2671

3370

else:

2672

3371

client["expires"] = (

2673

3372

datetime.datetime.utcnow()

2674

3373

+ client["timeout"])

2675

logger.debug("Last checker succeeded,"

2676

" keeping {} enabled".format(

2677

client_name))

3374

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

3375

" enabled", client_name)

2678

3376

try:

2679

3377

client["secret"] = pgp.decrypt(

2680

3378

client["encrypted_secret"],

2681

3379

client_settings[client_name]["secret"])

2682

3380

except PGPError:

2683

3381

# If decryption fails, we use secret from new settings

2684

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

2685

client_name))

3382

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

3383

client_name)

2686

3384

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

2687

3385

["secret"])

2688

3386

2689

3387

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

2690

3388

for client_name in (set(old_client_settings)

2691

3389

- set(client_settings)):

2693

3391

for client_name in (set(client_settings)

2694

3392

- set(old_client_settings)):

2695

3393

clients_data[client_name] = client_settings[client_name]

2696

3394

2697

3395

# Create all client objects

2698

3396

for client_name, client in clients_data.items():

2699

3397

tcp_server.clients[client_name] = client_class(

2700

name = client_name,

2701

settings = client,

2702

server_settings = server_settings)

2703

3398

name=client_name,

3399

settings=client,

3400

server_settings=server_settings)

3401

2704

3402

if not tcp_server.clients:

2705

logger.warning("No clients defined")

2706

3403

log.warning("No clients defined")

3404

2707

3405

if not foreground:

2708

3406

if pidfile is not None:

2709

3407

pid = os.getpid()

2711

3409

with pidfile:

2712

3410

print(pid, file=pidfile)

2713

3411

except IOError:

2714

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

2715

pidfilename, pid)

3412

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

3413

pidfilename, pid)

2716

3414

del pidfile

2717

3415

del pidfilename

2718

2719

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

2720

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

2721

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

2722

3421

if use_dbus:

2723

3422

2724

3423

@alternate_dbus_interfaces(

2725

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

2726

class MandosDBusService(DBusObjectWithProperties):

3424

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

3425

class MandosDBusService(DBusObjectWithObjectManager):

2727

3426

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

2728

3427

2729

3428

def __init__(self):

2730

3429

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

2731

3430

2732

3431

_interface = "se.recompile.Mandos"

2733

2734

@dbus_interface_annotations(_interface)

2735

def _foo(self):

2736

return {

2737

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

2738

"false" }

2739

3432

2740

3433

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

2741

3434

def ClientAdded(self, objpath):

2742

3435

"D-Bus signal"

2743

3436

pass

2744

3437

2745

3438

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

2746

def ClientNotFound(self, fingerprint, address):

3439

def ClientNotFound(self, key_id, address):

2747

3440

"D-Bus signal"

2748

3441

pass

2749

3442

3443

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

3444

"true"})

2750

3445

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

2751

3446

def ClientRemoved(self, objpath, name):

2752

3447

"D-Bus signal"

2753

3448

pass

2754

3449

3450

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

3451

"true"})

2755

3452

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

2756

3453

def GetAllClients(self):

2757

3454

"D-Bus method"

2758

3455

return dbus.Array(c.dbus_object_path for c in

2759

tcp_server.clients.itervalues())

2760

3456

tcp_server.clients.values())

3457

3458

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

3459

"true"})

2761

3460

@dbus.service.method(_interface,

2762

3461

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

2763

3462

def GetAllClientsWithProperties(self):

2764

3463

"D-Bus method"

2765

3464

return dbus.Dictionary(

2766

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

2767

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

3465

{c.dbus_object_path: c.GetAll(

3466

"se.recompile.Mandos.Client")

3467

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

2768

3468

signature="oa{sv}")

2769

3469

2770

3470

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

2771

3471

def RemoveClient(self, object_path):

2772

3472

"D-Bus method"

2773

for c in tcp_server.clients.itervalues():

3473

for c in tcp_server.clients.values():

2774

3474

if c.dbus_object_path == object_path:

2775

3475

del tcp_server.clients[c.name]

2776

3476

c.remove_from_connection()

2777

# Don't signal anything except ClientRemoved

3477

# Don't signal the disabling

2778

3478

c.disable(quiet=True)

2779

# Emit D-Bus signal

2780

self.ClientRemoved(object_path, c.name)

3479

# Emit D-Bus signal for removal

3480

self.client_removed_signal(c)

2781

3481

return

2782

3482

raise KeyError(object_path)

2783

3483

2784

3484

del _interface

2785

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

2786

3522

mandos_dbus_service = MandosDBusService()

2787

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

2788

3529

def cleanup():

2789

3530

"Cleanup function; run on exit"

2790

3531

if zeroconf:

2791

3532

service.cleanup()

2792

2793

multiprocessing.active_children()

2794

wnull.close()

3533

3534

mp.active_children()

3535

wn.close()

2795

3536

if not (tcp_server.clients or client_settings):

2796

3537

return

2797

3538

2798

3539

# Store client before exiting. Secrets are encrypted with key

2799

3540

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

2800

3541

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

2801

3542

clients = {}

2802

3543

with PGPEngine() as pgp:

2803

for client in tcp_server.clients.itervalues():

3544

for client in tcp_server.clients.values():

2804

3545

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

2805

3546

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

2806

3547

key)

2807

3548

client_dict = {}

2808

3549

2809

3550

# A list of attributes that can not be pickled

2810

3551

# + secret.

2811

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

2812

"checker", "server_settings" }

3552

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

3553

"checker", "server_settings"}

2813

3554

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

2814

3555

.Object):

2815

3556

exclude.add(name)

2816

3557

2817

3558

client_dict["encrypted_secret"] = (client

2818

3559

.encrypted_secret)

2819

3560

for attr in client.client_structure:

2820

3561

if attr not in exclude:

2821

3562

client_dict[attr] = getattr(client, attr)

2822

3563

2823

3564

clients[client.name] = client_dict

2824

3565

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

2825

3566

2826

3567

try:

2827

3568

with tempfile.NamedTemporaryFile(

2828

mode='wb',

3569

mode="wb",

2829

3570

suffix=".pickle",

2830

prefix='clients-',

3571

prefix="clients-",

2831

3572

dir=os.path.dirname(stored_state_path),

2832

3573

delete=False) as stored_state:

2833

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

3574

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

3575

protocol=2)

2834

3576

tempname = stored_state.name

2835

3577

os.rename(tempname, stored_state_path)

2836

3578

except (IOError, OSError) as e:

2840

3582

except NameError:

2841

3583

pass

2842

3584

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

2843

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

2844

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

3585

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

3586

os.strerror(e.errno))

2845

3587

else:

2846

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

2847

exc_info=e)

3588

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

3589

exc_info=e)

2848

3590

raise

2849

3591

2850

3592

# Delete all clients, and settings from config

2851

3593

while tcp_server.clients:

2852

3594

name, client = tcp_server.clients.popitem()

2853

3595

if use_dbus:

2854

3596

client.remove_from_connection()

2855

# Don't signal anything except ClientRemoved

3597

# Don't signal the disabling

2856

3598

client.disable(quiet=True)

3599

# Emit D-Bus signal for removal

2857

3600

if use_dbus:

2858

# Emit D-Bus signal

2859

mandos_dbus_service.ClientRemoved(

2860

client.dbus_object_path, client.name)

3601

mandos_dbus_service.client_removed_signal(client)

2861

3602

client_settings.clear()

2862

3603

2863

3604

atexit.register(cleanup)

2864

2865

for client in tcp_server.clients.itervalues():

3605

3606

for client in tcp_server.clients.values():

2866

3607

if use_dbus:

2867

# Emit D-Bus signal

2868

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3608

# Emit D-Bus signal for adding

3609

mandos_dbus_service.client_added_signal(client)

2869

3610

# Need to initiate checking of clients

2870

3611

if client.enabled:

2871

3612

client.init_checker()

2872

3613

2873

3614

tcp_server.enable()

2874

3615

tcp_server.server_activate()

2875

3616

2876

3617

# Find out what port we got

2877

3618

if zeroconf:

2878

3619

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

2879

3620

if use_ipv6:

2880

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

2881

" flowinfo %d, scope_id %d",

2882

*tcp_server.socket.getsockname())

3621

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

3622

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

2883

3623

else: # IPv4

2884

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

2885

*tcp_server.socket.getsockname())

2886

2887

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

2888

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

2889

3629

try:

2890

3630

if zeroconf:

2891

3631

# From the Avahi example code

2892

3632

try:

2893

3633

service.activate()

2894

3634

except dbus.exceptions.DBusException as error:

2895

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

3635

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

2896

3636

cleanup()

2897

3637

sys.exit(1)

2898

3638

# End of Avahi example code

2899

2900

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

2901

lambda *args, **kwargs:

2902

(tcp_server.handle_request

2903

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

2904

2905

logger.debug("Starting main loop")

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

2906

3647

main_loop.run()

2907

3648

except AvahiError as error:

2908

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

3649

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

2909

3650

cleanup()

2910

3651

sys.exit(1)

2911

3652

except KeyboardInterrupt:

2912

3653

if debug:

2913

3654

print("", file=sys.stderr)

2914

logger.debug("Server received KeyboardInterrupt")

2915

logger.debug("Server exiting")

3655

log.debug("Server received KeyboardInterrupt")

3656

log.debug("Server exiting")

2916

3657

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

2917

3658

cleanup()

2918

3659

2919

2920

if __name__ == '__main__':

2921

main()

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: