/mandos/release : revision 237.7.332

1

#!/usr/bin/python3 -bI

2

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

3

#

1

#!/usr/bin/python2.7

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

33

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

37

from future_builtins import *

41

38

42

import sys

43

import unittest

44

import argparse

45

import logging

46

import os

47

39

try:

48

40

import SocketServer as socketserver

49

41

except ImportError:

50

42

import socketserver

51

43

import socket

44

import argparse

52

45

import datetime

53

46

import errno

47

import gnutls.crypto

48

import gnutls.connection

49

import gnutls.errors

50

import gnutls.library.functions

51

import gnutls.library.constants

52

import gnutls.library.types

54

53

try:

55

54

import ConfigParser as configparser

56

55

except ImportError:

57

56

import configparser

57

import sys

58

import re

59

import os

59

60

import signal

60

61

import subprocess

61

62

import atexit

62

63

import stat

64

import logging

63

65

import logging.handlers

64

66

import pwd

65

67

import contextlib

77

79

import itertools

78

80

import collections

79

81

import codecs

80

import random

81

import shlex

82

83

import dbus

84

import dbus.service

85

import gi

86

from gi.repository import GLib

85

try:

86

import gobject

87

except ImportError:

88

from gi.repository import GObject as gobject

89

import avahi

87

90

from dbus.mainloop.glib import DBusGMainLoop

88

91

import ctypes

89

92

import ctypes.util

90

93

import xml.dom.minidom

91

94

import inspect

92

95

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

input = raw_input

97

98

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

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Show warnings by default

114

if not sys.warnoptions:

115

import warnings

116

warnings.simplefilter("default")

117

118

# Try to find the value of SO_BINDTODEVICE:

119

try:

120

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

121

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

96

try:

122

97

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

123

98

except AttributeError:

124

99

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

127

100

from IN import SO_BINDTODEVICE

128

101

except ImportError:

129

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

130

# Try running the C preprocessor:

131

try:

132

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

133

"/dev/stdin"],

134

stdin=subprocess.PIPE,

135

stdout=subprocess.PIPE)

136

stdout = cc.communicate(

137

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

138

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

139

except (OSError, ValueError, IndexError):

140

# No value found

141

SO_BINDTODEVICE = None

142

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

145

146

version = "1.8.16"

102

SO_BINDTODEVICE = None

103

104

if sys.version_info.major == 2:

105

str = unicode

106

107

version = "1.6.9"

147

108

stored_state_file = "clients.pickle"

148

109

149

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

150

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

110

logger = logging.getLogger()

151

111

syslogger = None

152

112

153

113

try:

154

114

if_nametoindex = ctypes.cdll.LoadLibrary(

155

115

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

156

116

except (OSError, AttributeError):

157

117

158

118

def if_nametoindex(interface):

159

119

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

160

120

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

165

125

return interface_index

166

126

167

127

168

def copy_function(func):

169

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

170

if sys.version_info.major == 2:

171

return types.FunctionType(func.func_code,

172

func.func_globals,

173

func.func_name,

174

func.func_defaults,

175

func.func_closure)

176

else:

177

return types.FunctionType(func.__code__,

178

func.__globals__,

179

func.__name__,

180

func.__defaults__,

181

func.__closure__)

182

183

184

128

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

185

129

"""init logger and add loglevel"""

186

130

187

131

global syslogger

188

132

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

133

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

134

address = "/dev/log"))

191

135

syslogger.setFormatter(logging.Formatter

192

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

193

" %(message)s"))

194

log.addHandler(syslogger)

195

136

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

137

' %(message)s'))

138

logger.addHandler(syslogger)

139

196

140

if debug:

197

141

console = logging.StreamHandler()

198

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

199

" [%(process)d]:"

200

" %(levelname)s:"

201

" %(message)s"))

202

log.addHandler(console)

203

log.setLevel(level)

142

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

143

' [%(process)d]:'

144

' %(levelname)s:'

145

' %(message)s'))

146

logger.addHandler(console)

147

logger.setLevel(level)

204

148

205

149

206

150

class PGPError(Exception):

208

152

pass

209

153

210

154

211

class PGPEngine:

155

class PGPEngine(object):

212

156

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

213

157

214

158

def __init__(self):

215

159

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

216

self.gpg = "gpg"

217

try:

218

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

219

for line in output.splitlines():

220

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

221

if name == b"gpg":

222

self.gpg = path

223

break

224

except OSError as e:

225

if e.errno != errno.ENOENT:

226

raise

227

self.gnupgargs = ["--batch",

228

"--homedir", self.tempdir,

229

"--force-mdc",

230

"--quiet"]

231

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

232

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

233

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

234

160

self.gnupgargs = ['--batch',

161

'--home', self.tempdir,

162

'--force-mdc',

163

'--quiet',

164

'--no-use-agent']

165

235

166

def __enter__(self):

236

167

return self

237

168

238

169

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

239

170

self._cleanup()

240

171

return False

241

172

242

173

def __del__(self):

243

174

self._cleanup()

244

175

245

176

def _cleanup(self):

246

177

if self.tempdir is not None:

247

178

# Delete contents of tempdir

248

179

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

249

topdown=False):

180

topdown = False):

250

181

for filename in files:

251

182

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

252

183

for dirname in dirs:

254

185

# Remove tempdir

255

186

os.rmdir(self.tempdir)

256

187

self.tempdir = None

257

188

258

189

def password_encode(self, password):

259

190

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

260

191

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

265

196

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

266

197

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

267

198

return encoded

268

199

269

200

def encrypt(self, data, password):

270

201

passphrase = self.password_encode(password)

271

202

with tempfile.NamedTemporaryFile(

272

203

dir=self.tempdir) as passfile:

273

204

passfile.write(passphrase)

274

205

passfile.flush()

275

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

276

"--passphrase-file",

206

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

207

'--passphrase-file',

277

208

passfile.name]

278

209

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

210

stdin = subprocess.PIPE,

211

stdout = subprocess.PIPE,

212

stderr = subprocess.PIPE)

213

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

283

214

if proc.returncode != 0:

284

215

raise PGPError(err)

285

216

return ciphertext

286

217

287

218

def decrypt(self, data, password):

288

219

passphrase = self.password_encode(password)

289

220

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

221

dir = self.tempdir) as passfile:

291

222

passfile.write(passphrase)

292

223

passfile.flush()

293

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

294

"--passphrase-file",

224

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

225

'--passphrase-file',

295

226

passfile.name]

296

227

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

228

stdin = subprocess.PIPE,

229

stdout = subprocess.PIPE,

230

stderr = subprocess.PIPE)

231

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

301

232

if proc.returncode != 0:

302

233

raise PGPError(err)

303

234

return decrypted_plaintext

304

235

305

236

306

# Pretend that we have an Avahi module

307

class avahi:

308

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

309

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

310

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

311

PROTO_INET = 0 # avahi-common/address.h

312

PROTO_INET6 = 1 # avahi-common/address.h

313

DBUS_NAME = "org.freedesktop.Avahi"

314

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

315

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

316

DBUS_PATH_SERVER = "/"

317

318

@staticmethod

319

def string_array_to_txt_array(t):

320

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

321

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

322

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

323

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

324

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

325

SERVER_INVALID = 0 # avahi-common/defs.h

326

SERVER_REGISTERING = 1 # avahi-common/defs.h

327

SERVER_RUNNING = 2 # avahi-common/defs.h

328

SERVER_COLLISION = 3 # avahi-common/defs.h

329

SERVER_FAILURE = 4 # avahi-common/defs.h

330

331

332

237

class AvahiError(Exception):

333

238

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

334

239

self.value = value

344

249

pass

345

250

346

251

347

class AvahiService:

252

class AvahiService(object):

348

253

"""An Avahi (Zeroconf) service.

349

254

350

255

Attributes:

351

256

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

352

257

Used to optionally bind to the specified interface.

353

name: string; Example: "Mandos"

354

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

258

name: string; Example: 'Mandos'

259

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

355

260

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

356

261

port: integer; what port to announce

357

262

TXT: list of strings; TXT record for the service

364

269

server: D-Bus Server

365

270

bus: dbus.SystemBus()

366

271

"""

367

272

368

273

def __init__(self,

369

interface=avahi.IF_UNSPEC,

370

name=None,

371

servicetype=None,

372

port=None,

373

TXT=None,

374

domain="",

375

host="",

376

max_renames=32768,

377

protocol=avahi.PROTO_UNSPEC,

378

bus=None):

274

interface = avahi.IF_UNSPEC,

275

name = None,

276

servicetype = None,

277

port = None,

278

TXT = None,

279

domain = "",

280

host = "",

281

max_renames = 32768,

282

protocol = avahi.PROTO_UNSPEC,

283

bus = None):

379

284

self.interface = interface

380

285

self.name = name

381

286

self.type = servicetype

390

295

self.server = None

391

296

self.bus = bus

392

297

self.entry_group_state_changed_match = None

393

298

394

299

def rename(self, remove=True):

395

300

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

396

301

if self.rename_count >= self.max_renames:

397

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

398

" after %i retries, exiting.",

399

self.rename_count)

302

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

303

" after %i retries, exiting.",

304

self.rename_count)

400

305

raise AvahiServiceError("Too many renames")

401

306

self.name = str(

402

307

self.server.GetAlternativeServiceName(self.name))

403

308

self.rename_count += 1

404

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

405

self.name)

309

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

310

self.name)

406

311

if remove:

407

312

self.remove()

408

313

try:

410

315

except dbus.exceptions.DBusException as error:

411

316

if (error.get_dbus_name()

412

317

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

413

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

318

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

414

319

return self.rename(remove=False)

415

320

else:

416

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

321

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

417

322

self.cleanup()

418

323

os._exit(1)

419

324

420

325

def remove(self):

421

326

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

422

327

if self.entry_group_state_changed_match is not None:

424

329

self.entry_group_state_changed_match = None

425

330

if self.group is not None:

426

331

self.group.Reset()

427

332

428

333

def add(self):

429

334

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

430

335

self.remove()

435

340

avahi.DBUS_INTERFACE_ENTRY_GROUP)

436

341

self.entry_group_state_changed_match = (

437

342

self.group.connect_to_signal(

438

"StateChanged", self.entry_group_state_changed))

439

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

440

self.name, self.type)

343

'StateChanged', self.entry_group_state_changed))

344

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

345

self.name, self.type)

441

346

self.group.AddService(

442

347

self.interface,

443

348

self.protocol,

447

352

dbus.UInt16(self.port),

448

353

avahi.string_array_to_txt_array(self.TXT))

449

354

self.group.Commit()

450

355

451

356

def entry_group_state_changed(self, state, error):

452

357

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

453

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

454

358

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

359

455

360

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

log.debug("Zeroconf service established.")

361

logger.debug("Zeroconf service established.")

457

362

elif state == avahi.ENTRY_GROUP_COLLISION:

458

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

363

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

459

364

self.rename()

460

365

elif state == avahi.ENTRY_GROUP_FAILURE:

461

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

462

str(error))

366

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

367

str(error))

463

368

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

464

369

465

370

def cleanup(self):

466

371

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

467

372

if self.group is not None:

472

377

pass

473

378

self.group = None

474

379

self.remove()

475

380

476

381

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

477

382

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

478

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

383

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

479

384

bad_states = {

480

385

avahi.SERVER_INVALID: "Zeroconf server invalid",

481

386

avahi.SERVER_REGISTERING: None,

485

390

if state in bad_states:

486

391

if bad_states[state] is not None:

487

392

if error is None:

488

log.error(bad_states[state])

393

logger.error(bad_states[state])

489

394

else:

490

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

395

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

491

396

self.cleanup()

492

397

elif state == avahi.SERVER_RUNNING:

493

398

try:

495

400

except dbus.exceptions.DBusException as error:

496

401

if (error.get_dbus_name()

497

402

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

498

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

403

logger.info("Local Zeroconf service name"

404

" collision.")

499

405

return self.rename(remove=False)

500

406

else:

501

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

407

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

502

408

self.cleanup()

503

409

os._exit(1)

504

410

else:

505

411

if error is None:

506

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

412

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

507

413

else:

508

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

509

414

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

415

510

416

def activate(self):

511

417

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

512

418

if self.server is None:

523

429

class AvahiServiceToSyslog(AvahiService):

524

430

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

525

431

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

526

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

527

**kwargs)

432

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

528

433

syslogger.setFormatter(logging.Formatter(

529

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

434

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

530

435

.format(self.name)))

531

436

return ret

532

437

533

534

# Pretend that we have a GnuTLS module

535

class gnutls:

536

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

537

538

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

539

if library is None:

540

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

541

_library = ctypes.cdll.LoadLibrary(library)

542

del library

543

544

# Unless otherwise indicated, the constants and types below are

545

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

546

547

# Constants

548

E_SUCCESS = 0

549

E_INTERRUPTED = -52

550

E_AGAIN = -28

551

CRT_OPENPGP = 2

552

CRT_RAWPK = 3

553

CLIENT = 2

554

SHUT_RDWR = 0

555

CRD_CERTIFICATE = 1

556

E_NO_CERTIFICATE_FOUND = -49

557

X509_FMT_DER = 0

558

NO_TICKETS = 1<<10

559

ENABLE_RAWPK = 1<<18

560

CTYPE_PEERS = 3

561

KEYID_USE_SHA256 = 1 # gnutls/x509.h

562

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

563

564

# Types

565

class _session_int(ctypes.Structure):

566

_fields_ = []

567

session_t = ctypes.POINTER(_session_int)

568

569

class certificate_credentials_st(ctypes.Structure):

570

_fields_ = []

571

certificate_credentials_t = ctypes.POINTER(

572

certificate_credentials_st)

573

certificate_type_t = ctypes.c_int

574

575

class datum_t(ctypes.Structure):

576

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

577

("size", ctypes.c_uint)]

578

579

class _openpgp_crt_int(ctypes.Structure):

580

_fields_ = []

581

openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)

582

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

583

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

584

credentials_type_t = ctypes.c_int

585

transport_ptr_t = ctypes.c_void_p

586

close_request_t = ctypes.c_int

587

588

# Exceptions

589

class Error(Exception):

590

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

591

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

592

# code is passed, convert it to a string with

593

# gnutls.strerror()

594

self.code = code

595

if message is None and code is not None:

596

message = gnutls.strerror(code).decode(

597

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

598

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

599

message, *args)

600

601

class CertificateSecurityError(Error):

602

pass

603

604

class PointerTo:

605

def __init__(self, cls):

606

self.cls = cls

607

608

def from_param(self, obj):

609

if not isinstance(obj, self.cls):

610

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

611

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

612

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

613

614

class CastToVoidPointer:

615

def __init__(self, cls):

616

self.cls = cls

617

618

def from_param(self, obj):

619

if not isinstance(obj, self.cls):

620

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

621

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

622

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

623

624

class With_from_param:

625

@classmethod

626

def from_param(cls, obj):

627

return obj._as_parameter_

628

629

# Classes

630

class Credentials(With_from_param):

631

def __init__(self):

632

self._as_parameter_ = gnutls.certificate_credentials_t()

633

gnutls.certificate_allocate_credentials(self)

634

self.type = gnutls.CRD_CERTIFICATE

635

636

def __del__(self):

637

gnutls.certificate_free_credentials(self)

638

639

class ClientSession(With_from_param):

640

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

641

self._as_parameter_ = gnutls.session_t()

642

gnutls_flags = gnutls.CLIENT

643

if gnutls.check_version(b"3.5.6"):

644

gnutls_flags |= gnutls.NO_TICKETS

645

if gnutls.has_rawpk:

646

gnutls_flags |= gnutls.ENABLE_RAWPK

647

gnutls.init(self, gnutls_flags)

648

del gnutls_flags

649

gnutls.set_default_priority(self)

650

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

651

gnutls.handshake_set_private_extensions(self, True)

652

self.socket = socket

653

if credentials is None:

654

credentials = gnutls.Credentials()

655

gnutls.credentials_set(self, credentials.type,

656

credentials)

657

self.credentials = credentials

658

659

def __del__(self):

660

gnutls.deinit(self)

661

662

def handshake(self):

663

return gnutls.handshake(self)

664

665

def send(self, data):

666

data = bytes(data)

667

data_len = len(data)

668

while data_len > 0:

669

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

670

data_len)

671

672

def bye(self):

673

return gnutls.bye(self, gnutls.SHUT_RDWR)

674

675

# Error handling functions

676

def _error_code(result):

677

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

678

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

679

if result >= gnutls.E_SUCCESS:

680

return result

681

if result == gnutls.E_NO_CERTIFICATE_FOUND:

682

raise gnutls.CertificateSecurityError(code=result)

683

raise gnutls.Error(code=result)

684

685

def _retry_on_error(result, func, arguments,

686

_error_code=_error_code):

687

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

688

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

689

while result < gnutls.E_SUCCESS:

690

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

691

return _error_code(result)

692

result = func(*arguments)

693

return result

694

695

# Unless otherwise indicated, the function declarations below are

696

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

697

698

# Functions

699

priority_set_direct = _library.gnutls_priority_set_direct

700

priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,

701

ctypes.POINTER(ctypes.c_char_p)]

702

priority_set_direct.restype = _error_code

703

704

init = _library.gnutls_init

705

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

706

init.restype = _error_code

707

708

set_default_priority = _library.gnutls_set_default_priority

709

set_default_priority.argtypes = [ClientSession]

710

set_default_priority.restype = _error_code

711

712

record_send = _library.gnutls_record_send

713

record_send.argtypes = [ClientSession, ctypes.c_void_p,

714

ctypes.c_size_t]

715

record_send.restype = ctypes.c_ssize_t

716

record_send.errcheck = _retry_on_error

717

718

certificate_allocate_credentials = (

719

_library.gnutls_certificate_allocate_credentials)

720

certificate_allocate_credentials.argtypes = [

721

PointerTo(Credentials)]

722

certificate_allocate_credentials.restype = _error_code

723

724

certificate_free_credentials = (

725

_library.gnutls_certificate_free_credentials)

726

certificate_free_credentials.argtypes = [Credentials]

727

certificate_free_credentials.restype = None

728

729

handshake_set_private_extensions = (

730

_library.gnutls_handshake_set_private_extensions)

731

handshake_set_private_extensions.argtypes = [ClientSession,

732

ctypes.c_int]

733

handshake_set_private_extensions.restype = None

734

735

credentials_set = _library.gnutls_credentials_set

736

credentials_set.argtypes = [ClientSession, credentials_type_t,

737

CastToVoidPointer(Credentials)]

738

credentials_set.restype = _error_code

739

740

strerror = _library.gnutls_strerror

741

strerror.argtypes = [ctypes.c_int]

742

strerror.restype = ctypes.c_char_p

743

744

certificate_type_get = _library.gnutls_certificate_type_get

745

certificate_type_get.argtypes = [ClientSession]

746

certificate_type_get.restype = _error_code

747

748

certificate_get_peers = _library.gnutls_certificate_get_peers

749

certificate_get_peers.argtypes = [ClientSession,

750

ctypes.POINTER(ctypes.c_uint)]

751

certificate_get_peers.restype = ctypes.POINTER(datum_t)

752

753

global_set_log_level = _library.gnutls_global_set_log_level

754

global_set_log_level.argtypes = [ctypes.c_int]

755

global_set_log_level.restype = None

756

757

global_set_log_function = _library.gnutls_global_set_log_function

758

global_set_log_function.argtypes = [log_func]

759

global_set_log_function.restype = None

760

761

deinit = _library.gnutls_deinit

762

deinit.argtypes = [ClientSession]

763

deinit.restype = None

764

765

handshake = _library.gnutls_handshake

766

handshake.argtypes = [ClientSession]

767

handshake.restype = ctypes.c_int

768

handshake.errcheck = _retry_on_error

769

770

transport_set_ptr = _library.gnutls_transport_set_ptr

771

transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]

772

transport_set_ptr.restype = None

773

774

bye = _library.gnutls_bye

775

bye.argtypes = [ClientSession, close_request_t]

776

bye.restype = ctypes.c_int

777

bye.errcheck = _retry_on_error

778

779

check_version = _library.gnutls_check_version

780

check_version.argtypes = [ctypes.c_char_p]

781

check_version.restype = ctypes.c_char_p

782

783

_need_version = b"3.3.0"

784

if check_version(_need_version) is None:

785

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

786

.format(_need_version))

787

788

_tls_rawpk_version = b"3.6.6"

789

has_rawpk = bool(check_version(_tls_rawpk_version))

790

791

if has_rawpk:

792

# Types

793

class pubkey_st(ctypes.Structure):

794

_fields = []

795

pubkey_t = ctypes.POINTER(pubkey_st)

796

797

x509_crt_fmt_t = ctypes.c_int

798

799

# All the function declarations below are from

800

# gnutls/abstract.h

801

pubkey_init = _library.gnutls_pubkey_init

802

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

803

pubkey_init.restype = _error_code

804

805

pubkey_import = _library.gnutls_pubkey_import

806

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

807

x509_crt_fmt_t]

808

pubkey_import.restype = _error_code

809

810

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

811

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

812

ctypes.POINTER(ctypes.c_ubyte),

813

ctypes.POINTER(ctypes.c_size_t)]

814

pubkey_get_key_id.restype = _error_code

815

816

pubkey_deinit = _library.gnutls_pubkey_deinit

817

pubkey_deinit.argtypes = [pubkey_t]

818

pubkey_deinit.restype = None

819

else:

820

# All the function declarations below are from

821

# gnutls/openpgp.h

822

823

openpgp_crt_init = _library.gnutls_openpgp_crt_init

824

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

825

openpgp_crt_init.restype = _error_code

826

827

openpgp_crt_import = _library.gnutls_openpgp_crt_import

828

openpgp_crt_import.argtypes = [openpgp_crt_t,

829

ctypes.POINTER(datum_t),

830

openpgp_crt_fmt_t]

831

openpgp_crt_import.restype = _error_code

832

833

openpgp_crt_verify_self = \

834

_library.gnutls_openpgp_crt_verify_self

835

openpgp_crt_verify_self.argtypes = [

836

openpgp_crt_t,

837

ctypes.c_uint,

838

ctypes.POINTER(ctypes.c_uint),

839

]

840

openpgp_crt_verify_self.restype = _error_code

841

842

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

843

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

844

openpgp_crt_deinit.restype = None

845

846

openpgp_crt_get_fingerprint = (

847

_library.gnutls_openpgp_crt_get_fingerprint)

848

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

849

ctypes.c_void_p,

850

ctypes.POINTER(

851

ctypes.c_size_t)]

852

openpgp_crt_get_fingerprint.restype = _error_code

853

854

if check_version(b"3.6.4"):

855

certificate_type_get2 = _library.gnutls_certificate_type_get2

856

certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]

857

certificate_type_get2.restype = _error_code

858

859

# Remove non-public functions

860

del _error_code, _retry_on_error

861

862

863

438

def call_pipe(connection, # : multiprocessing.Connection

864

439

func, *args, **kwargs):

865

440

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

866

441

867

442

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

868

443

return value on the provided multiprocessing.Connection.

869

444

"""

870

445

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

871

446

connection.close()

872

447

873

874

class Client:

448

class Client(object):

875

449

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

876

450

877

451

Attributes:

878

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

452

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

879

453

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

880

454

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

881

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

882

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

883

running.

884

checker_callback_tag: a GLib event source tag, or None

455

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

456

to see if the client lives.

457

'None' if no process is running.

458

checker_callback_tag: a gobject event source tag, or None

885

459

checker_command: string; External command which is run to check

886

460

if client lives. %() expansions are done at

887

461

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

888

462

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

889

checker_initiator_tag: a GLib event source tag, or None

463

checker_initiator_tag: a gobject event source tag, or None

890

464

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

891

465

client_structure: Object describing what attributes a client has

892

466

and is used for storing the client at exit

893

467

current_checker_command: string; current running checker_command

894

disable_initiator_tag: a GLib event source tag, or None

468

disable_initiator_tag: a gobject event source tag, or None

895

469

enabled: bool()

896

470

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

897

uniquely identify an OpenPGP client

898

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

899

a client using raw public keys

471

uniquely identify the client

900

472

host: string; available for use by the checker command

901

473

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

902

474

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

918

490

disabled, or None

919

491

server_settings: The server_settings dict from main()

920

492

"""

921

493

922

494

runtime_expansions = ("approval_delay", "approval_duration",

923

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

495

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

924

496

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

925

497

"last_approval_request", "last_checked_ok",

926

498

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

935

507

"approved_by_default": "True",

936

508

"enabled": "True",

937

509

}

938

510

939

511

@staticmethod

940

512

def config_parser(config):

941

513

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

948

520

for client_name in config.sections():

949

521

section = dict(config.items(client_name))

950

522

client = settings[client_name] = {}

951

523

952

524

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

953

525

# Reformat values from string types to Python types

954

526

client["approved_by_default"] = config.getboolean(

955

527

client_name, "approved_by_default")

956

528

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

957

529

"enabled")

958

959

# Uppercase and remove spaces from key_id and fingerprint

960

# for later comparison purposes with return value from the

961

# key_id() and fingerprint() functions

962

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

963

.replace(" ", ""))

964

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

965

"").upper()

530

531

# Uppercase and remove spaces from fingerprint for later

532

# comparison purposes with return value from the

533

# fingerprint() function

534

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

966

535

.replace(" ", ""))

967

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

968

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

969

" fingerprint", client_name)

970

del settings[client_name]

971

continue

972

536

if "secret" in section:

973

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

974

.encode("utf-8"),

975

"base64")

537

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

976

538

elif "secfile" in section:

977

539

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

978

540

(section["secfile"])),

993

555

client["last_approval_request"] = None

994

556

client["last_checked_ok"] = None

995

557

client["last_checker_status"] = -2

996

558

997

559

return settings

998

999

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

560

561

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

1000

562

self.name = name

1001

563

if server_settings is None:

1002

564

server_settings = {}

1004

566

# adding all client settings

1005

567

for setting, value in settings.items():

1006

568

setattr(self, setting, value)

1007

569

1008

570

if self.enabled:

1009

571

if not hasattr(self, "last_enabled"):

1010

572

self.last_enabled = datetime.datetime.utcnow()

1014

576

else:

1015

577

self.last_enabled = None

1016

578

self.expires = None

1017

1018

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

1019

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

1020

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

579

580

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

581

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

1021

582

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

1022

583

datetime.datetime.utcnow())

1023

584

1024

585

# attributes specific for this server instance

1025

586

self.checker = None

1026

587

self.checker_initiator_tag = None

1032

593

self.changedstate = multiprocessing_manager.Condition(

1033

594

multiprocessing_manager.Lock())

1034

595

self.client_structure = [attr

1035

for attr in self.__dict__.keys()

596

for attr in self.__dict__.iterkeys()

1036

597

if not attr.startswith("_")]

1037

598

self.client_structure.append("client_structure")

1038

599

1039

600

for name, t in inspect.getmembers(

1040

601

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

1041

602

if not name.startswith("_"):

1042

603

self.client_structure.append(name)

1043

604

1044

605

# Send notice to process children that client state has changed

1045

606

def send_changedstate(self):

1046

607

with self.changedstate:

1047

608

self.changedstate.notify_all()

1048

609

1049

610

def enable(self):

1050

611

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

1051

612

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

1052

613

# Already enabled

1053

614

return

615

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

1054

616

self.enabled = True

1055

617

self.last_enabled = datetime.datetime.utcnow()

1056

618

self.init_checker()

1057

619

self.send_changedstate()

1058

620

1059

621

def disable(self, quiet=True):

1060

622

"""Disable this client."""

1061

623

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

1062

624

return False

1063

625

if not quiet:

1064

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

626

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

1065

627

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

1066

GLib.source_remove(self.disable_initiator_tag)

628

gobject.source_remove(self.disable_initiator_tag)

1067

629

self.disable_initiator_tag = None

1068

630

self.expires = None

1069

631

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

1070

GLib.source_remove(self.checker_initiator_tag)

632

gobject.source_remove(self.checker_initiator_tag)

1071

633

self.checker_initiator_tag = None

1072

634

self.stop_checker()

1073

635

self.enabled = False

1074

636

if not quiet:

1075

637

self.send_changedstate()

1076

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

638

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

1077

639

return False

1078

640

1079

641

def __del__(self):

1080

642

self.disable()

1081

1082

def init_checker(self, randomize_start=False):

1083

# Schedule a new checker to be started a randomly selected

1084

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

1085

# the startup of checkers over time when the server is

1086

# started.

643

644

def init_checker(self):

645

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

646

# and every interval from then on.

1087

647

if self.checker_initiator_tag is not None:

1088

GLib.source_remove(self.checker_initiator_tag)

1089

interval_milliseconds = int(self.interval.total_seconds()

1090

* 1000)

1091

if randomize_start:

1092

delay_milliseconds = random.randrange(

1093

interval_milliseconds + 1)

1094

else:

1095

delay_milliseconds = interval_milliseconds

1096

self.checker_initiator_tag = GLib.timeout_add(

1097

delay_milliseconds, self.start_checker, randomize_start)

1098

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

1099

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

1100

# expire at the soonest one interval after a checker was

1101

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

1102

# time might have to be extended.

1103

now = datetime.datetime.utcnow()

1104

self.expires = now + delay + self.interval

1105

# Schedule a disable() at expire time

648

gobject.source_remove(self.checker_initiator_tag)

649

self.checker_initiator_tag = gobject.timeout_add(

650

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

651

self.start_checker)

652

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

1106

653

if self.disable_initiator_tag is not None:

1107

GLib.source_remove(self.disable_initiator_tag)

1108

self.disable_initiator_tag = GLib.timeout_add(

1109

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

1110

self.disable)

1111

654

gobject.source_remove(self.disable_initiator_tag)

655

self.disable_initiator_tag = gobject.timeout_add(

656

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

657

# Also start a new checker *right now*.

658

self.start_checker()

659

1112

660

def checker_callback(self, source, condition, connection,

1113

661

command):

1114

662

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

663

self.checker_callback_tag = None

664

self.checker = None

1115

665

# Read return code from connection (see call_pipe)

1116

666

returncode = connection.recv()

1117

667

connection.close()

1118

if self.checker is not None:

1119

self.checker.join()

1120

self.checker_callback_tag = None

1121

self.checker = None

1122

668

1123

669

if returncode >= 0:

1124

670

self.last_checker_status = returncode

1125

671

self.last_checker_signal = None

1126

672

if self.last_checker_status == 0:

1127

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

673

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

674

vars(self))

1128

675

self.checked_ok()

1129

676

else:

1130

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

677

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

1131

678

else:

1132

679

self.last_checker_status = -1

1133

680

self.last_checker_signal = -returncode

1134

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

681

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

682

vars(self))

1135

683

return False

1136

684

1137

685

def checked_ok(self):

1138

686

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

1139

687

self.last_checked_ok = datetime.datetime.utcnow()

1140

688

self.last_checker_status = 0

1141

689

self.last_checker_signal = None

1142

690

self.bump_timeout()

1143

691

1144

692

def bump_timeout(self, timeout=None):

1145

693

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

1146

694

if timeout is None:

1147

695

timeout = self.timeout

1148

696

if self.disable_initiator_tag is not None:

1149

GLib.source_remove(self.disable_initiator_tag)

697

gobject.source_remove(self.disable_initiator_tag)

1150

698

self.disable_initiator_tag = None

1151

699

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

1152

self.disable_initiator_tag = GLib.timeout_add(

700

self.disable_initiator_tag = gobject.timeout_add(

1153

701

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

1154

702

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

1155

703

1156

704

def need_approval(self):

1157

705

self.last_approval_request = datetime.datetime.utcnow()

1158

1159

def start_checker(self, start_was_randomized=False):

706

707

def start_checker(self):

1160

708

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

1161

709

1162

710

If a checker already exists, leave it running and do

1163

711

nothing."""

1164

712

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

1169

717

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

1170

718

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

1171

719

# should be.

1172

720

1173

721

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

1174

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

722

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

1175

723

self.checker.join()

1176

724

self.checker = None

1177

725

# Start a new checker if needed

1178

726

if self.checker is None:

1179

727

# Escape attributes for the shell

1180

728

escaped_attrs = {

1181

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

1182

for attr in self.runtime_expansions}

729

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

730

for attr in self.runtime_expansions }

1183

731

try:

1184

732

command = self.checker_command % escaped_attrs

1185

733

except TypeError as error:

1186

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

1187

self.checker_command, exc_info=error)

734

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

735

self.checker_command,

736

exc_info=error)

1188

737

return True # Try again later

1189

738

self.current_checker_command = command

1190

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

739

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

740

self.name)

1191

741

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

1192

742

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

1193

743

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

1195

745

# The exception is when not debugging but nevertheless

1196

746

# running in the foreground; use the previously

1197

747

# created wnull.

1198

popen_args = {"close_fds": True,

1199

"shell": True,

1200

"cwd": "/"}

748

popen_args = { "close_fds": True,

749

"shell": True,

750

"cwd": "/" }

1201

751

if (not self.server_settings["debug"]

1202

752

and self.server_settings["foreground"]):

1203

753

popen_args.update({"stdout": wnull,

1204

"stderr": wnull})

1205

pipe = multiprocessing.Pipe(duplex=False)

754

"stderr": wnull })

755

pipe = multiprocessing.Pipe(duplex = False)

1206

756

self.checker = multiprocessing.Process(

1207

target=call_pipe,

1208

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

1209

kwargs=popen_args)

757

target = call_pipe,

758

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

759

kwargs = popen_args)

1210

760

self.checker.start()

1211

self.checker_callback_tag = GLib.io_add_watch(

1212

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

1213

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

761

self.checker_callback_tag = gobject.io_add_watch(

762

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

1214

763

self.checker_callback, pipe[0], command)

1215

if start_was_randomized:

1216

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

1217

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

1218

# interval from then on.

1219

now = datetime.datetime.utcnow()

1220

self.checker_initiator_tag = GLib.timeout_add(

1221

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

1222

self.start_checker)

1223

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

1224

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

1225

return False

1226

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

764

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

1227

765

return True

1228

766

1229

767

def stop_checker(self):

1230

768

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

1231

769

if self.checker_callback_tag:

1232

GLib.source_remove(self.checker_callback_tag)

770

gobject.source_remove(self.checker_callback_tag)

1233

771

self.checker_callback_tag = None

1234

772

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

1235

773

return

1236

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

774

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

1237

775

self.checker.terminate()

1238

776

self.checker = None

1239

777

1244

782

byte_arrays=False):

1245

783

"""Decorators for marking methods of a DBusObjectWithProperties to

1246

784

become properties on the D-Bus.

1247

785

1248

786

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

1249

787

and with one argument by "Set".

1250

788

1251

789

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

1252

790

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

1253

791

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

1257

795

if byte_arrays and signature != "ay":

1258

796

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

1259

797

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

1260

798

1261

799

def decorator(func):

1262

800

func._dbus_is_property = True

1263

801

func._dbus_interface = dbus_interface

1266

804

func._dbus_name = func.__name__

1267

805

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

1268

806

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

1269

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

807

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1270

808

return func

1271

809

1272

810

return decorator

1273

811

1274

812

1275

813

def dbus_interface_annotations(dbus_interface):

1276

814

"""Decorator for marking functions returning interface annotations

1277

815

1278

816

Usage:

1279

817

1280

818

@dbus_interface_annotations("org.example.Interface")

1281

819

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

1282

820

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

1283

821

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

1284

822

"false"}

1285

823

"""

1286

824

1287

825

def decorator(func):

1288

826

func._dbus_is_interface = True

1289

827

func._dbus_interface = dbus_interface

1290

828

func._dbus_name = dbus_interface

1291

829

return func

1292

830

1293

831

return decorator

1294

832

1295

833

1296

834

def dbus_annotations(annotations):

1297

835

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

1298

836

Usage:

1299

837

1300

838

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

1301

839

"org.freedesktop.DBus.Property."

1302

840

"EmitsChangedSignal": "false"})

1304

842

access="r")

1305

843

def Property_dbus_property(self):

1306

844

return dbus.Boolean(False)

1307

845

1308

846

See also the DBusObjectWithAnnotations class.

1309

847

"""

1310

848

1311

849

def decorator(func):

1312

850

func._dbus_annotations = annotations

1313

851

return func

1314

852

1315

853

return decorator

1316

854

1317

855

1335

873

1336

874

class DBusObjectWithAnnotations(dbus.service.Object):

1337

875

"""A D-Bus object with annotations.

1338

876

1339

877

Classes inheriting from this can use the dbus_annotations

1340

878

decorator to add annotations to methods or signals.

1341

879

"""

1342

880

1343

881

@staticmethod

1344

882

def _is_dbus_thing(thing):

1345

883

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

1346

884

1347

885

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

1348

886

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

1349

887

"""

1350

888

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

1351

889

False)

1352

890

1353

891

def _get_all_dbus_things(self, thing):

1354

892

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

1355

893

"""

1358

896

for cls in self.__class__.__mro__

1359

897

for name, athing in

1360

898

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

1361

899

1362

900

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1363

out_signature="s",

1364

path_keyword="object_path",

1365

connection_keyword="connection")

901

out_signature = "s",

902

path_keyword = 'object_path',

903

connection_keyword = 'connection')

1366

904

def Introspect(self, object_path, connection):

1367

905

"""Overloading of standard D-Bus method.

1368

906

1369

907

Inserts annotation tags on methods and signals.

1370

908

"""

1371

909

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

1372

910

connection)

1373

911

try:

1374

912

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

1375

913

1376

914

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

1377

915

# Add annotation tags

1378

916

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

1405

943

if_tag.appendChild(ann_tag)

1406

944

# Fix argument name for the Introspect method itself

1407

945

if (if_tag.getAttribute("name")

1408

== dbus.INTROSPECTABLE_IFACE):

946

== dbus.INTROSPECTABLE_IFACE):

1409

947

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

1410

948

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

1411

949

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

1417

955

document.unlink()

1418

956

except (AttributeError, xml.dom.DOMException,

1419

957

xml.parsers.expat.ExpatError) as error:

1420

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

1421

exc_info=error)

958

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

959

exc_info=error)

1422

960

return xmlstring

1423

961

1424

962

1425

963

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1426

964

"""A D-Bus object with properties.

1427

965

1428

966

Classes inheriting from this can use the dbus_service_property

1429

967

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

1430

968

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

1431

969

"""

1432

970

1433

971

def _get_dbus_property(self, interface_name, property_name):

1434

972

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

1435

973

property with the specified name and interface.

1440

978

if (value._dbus_name == property_name

1441

979

and value._dbus_interface == interface_name):

1442

980

return value.__get__(self)

1443

981

1444

982

# No such property

1445

983

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

1446

984

self.dbus_object_path, interface_name, property_name))

1447

1448

@classmethod

1449

def _get_all_interface_names(cls):

1450

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

1451

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

1452

"_dbus_interface", None)

1453

for x in (inspect.getmro(cls))

1454

for attr in dir(x))

1455

if name is not None)

1456

985

1457

986

@dbus.service.method(dbus.PROPERTIES_IFACE,

1458

987

in_signature="ss",

1459

988

out_signature="v")

1467

996

if not hasattr(value, "variant_level"):

1468

997

return value

1469

998

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

1470

999

1471

1000

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

1472

1001

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

1473

1002

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

1482

1011

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

1483

1012

"'ay' signature {!r}"

1484

1013

.format(prop._dbus_signature))

1485

value = dbus.ByteArray(bytes(value))

1014

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

1015

for byte in value))

1486

1016

prop(value)

1487

1017

1488

1018

@dbus.service.method(dbus.PROPERTIES_IFACE,

1489

1019

in_signature="s",

1490

1020

out_signature="a{sv}")

1491

1021

def GetAll(self, interface_name):

1492

1022

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

1493

1023

standard.

1494

1024

1495

1025

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

1496

1026

"""

1497

1027

properties = {}

1508

1038

properties[name] = value

1509

1039

continue

1510

1040

properties[name] = type(value)(

1511

value, variant_level=value.variant_level + 1)

1041

value, variant_level = value.variant_level + 1)

1512

1042

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

1513

1043

1514

1044

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

1515

1045

def PropertiesChanged(self, interface_name, changed_properties,

1516

1046

invalidated_properties):

1518

1048

standard.

1519

1049

"""

1520

1050

pass

1521

1051

1522

1052

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1523

1053

out_signature="s",

1524

path_keyword="object_path",

1525

connection_keyword="connection")

1054

path_keyword='object_path',

1055

connection_keyword='connection')

1526

1056

def Introspect(self, object_path, connection):

1527

1057

"""Overloading of standard D-Bus method.

1528

1058

1529

1059

Inserts property tags and interface annotation tags.

1530

1060

"""

1531

1061

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1533

1063

connection)

1534

1064

try:

1535

1065

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

1536

1066

1537

1067

def make_tag(document, name, prop):

1538

1068

e = document.createElement("property")

1539

1069

e.setAttribute("name", name)

1540

1070

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

1541

1071

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

1542

1072

return e

1543

1073

1544

1074

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

1545

1075

# Add property tags

1546

1076

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

1584

1114

document.unlink()

1585

1115

except (AttributeError, xml.dom.DOMException,

1586

1116

xml.parsers.expat.ExpatError) as error:

1587

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

1588

exc_info=error)

1589

return xmlstring

1590

1591

1592

try:

1593

dbus.OBJECT_MANAGER_IFACE

1594

except AttributeError:

1595

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

1596

1597

1598

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1599

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

1600

1601

Classes inheriting from this exposes the standard

1602

GetManagedObjects call and the InterfacesAdded and

1603

InterfacesRemoved signals on the standard

1604

"org.freedesktop.DBus.ObjectManager" interface.

1605

1606

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

1607

manually.

1608

"""

1609

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1610

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

1611

def GetManagedObjects(self):

1612

"""This function must be overridden"""

1613

raise NotImplementedError()

1614

1615

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1616

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

1617

def InterfacesAdded(self, object_path, interfaces_and_properties):

1618

pass

1619

1620

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

1621

def InterfacesRemoved(self, object_path, interfaces):

1622

pass

1623

1624

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1625

out_signature="s",

1626

path_keyword="object_path",

1627

connection_keyword="connection")

1628

def Introspect(self, object_path, connection):

1629

"""Overloading of standard D-Bus method.

1630

1631

Override return argument name of GetManagedObjects to be

1632

"objpath_interfaces_and_properties"

1633

"""

1634

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1635

object_path,

1636

connection)

1637

try:

1638

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

1639

1640

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

1641

# Fix argument name for the GetManagedObjects method

1642

if (if_tag.getAttribute("name")

1643

== dbus.OBJECT_MANAGER_IFACE):

1644

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

1645

if (cn.getAttribute("name")

1646

== "GetManagedObjects"):

1647

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

1648

if (arg.getAttribute("direction")

1649

== "out"):

1650

arg.setAttribute(

1651

"name",

1652

"objpath_interfaces"

1653

"_and_properties")

1654

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

1655

document.unlink()

1656

except (AttributeError, xml.dom.DOMException,

1657

xml.parsers.expat.ExpatError) as error:

1658

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

1659

exc_info=error)

1117

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

1118

exc_info=error)

1660

1119

return xmlstring

1661

1120

1662

1121

1663

1122

def datetime_to_dbus(dt, variant_level=0):

1664

1123

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

1665

1124

if dt is None:

1666

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

1125

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

1667

1126

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

1668

1127

1669

1128

1672

1131

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

1673

1132

interface names according to the "alt_interface_names" mapping.

1674

1133

Usage:

1675

1134

1676

1135

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

1677

1136

"net.example.AlternateInterface"})

1678

1137

class SampleDBusObject(dbus.service.Object):

1679

1138

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

1680

1139

def SampleDBusMethod():

1681

1140

pass

1682

1141

1683

1142

The above "SampleDBusMethod" on "SampleDBusObject" will be

1684

1143

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

1685

1144

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

1686

1145

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

1687

1146

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

1688

1147

1689

1148

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

1690

1149

(from DBusObjectWithProperties) and interfaces (from the

1691

1150

dbus_interface_annotations decorator).

1692

1151

"""

1693

1152

1694

1153

def wrapper(cls):

1695

1154

for orig_interface_name, alt_interface_name in (

1696

1155

alt_interface_names.items()):

1711

1170

interface_names.add(alt_interface)

1712

1171

# Is this a D-Bus signal?

1713

1172

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

1714

# Extract the original non-method undecorated

1715

# function by black magic

1716

1173

if sys.version_info.major == 2:

1174

# Extract the original non-method undecorated

1175

# function by black magic

1717

1176

nonmethod_func = (dict(

1718

1177

zip(attribute.func_code.co_freevars,

1719

1178

attribute.__closure__))

1720

1179

["func"].cell_contents)

1721

1180

else:

1722

nonmethod_func = (dict(

1723

zip(attribute.__code__.co_freevars,

1724

attribute.__closure__))

1725

["func"].cell_contents)

1181

nonmethod_func = attribute

1726

1182

# Create a new, but exactly alike, function

1727

1183

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

1728

1184

# with the alternate D-Bus interface name

1729

new_function = copy_function(nonmethod_func)

1185

if sys.version_info.major == 2:

1186

new_function = types.FunctionType(

1187

nonmethod_func.func_code,

1188

nonmethod_func.func_globals,

1189

nonmethod_func.func_name,

1190

nonmethod_func.func_defaults,

1191

nonmethod_func.func_closure)

1192

else:

1193

new_function = types.FunctionType(

1194

nonmethod_func.__code__,

1195

nonmethod_func.__globals__,

1196

nonmethod_func.__name__,

1197

nonmethod_func.__defaults__,

1198

nonmethod_func.__closure__)

1730

1199

new_function = (dbus.service.signal(

1731

1200

alt_interface,

1732

1201

attribute._dbus_signature)(new_function))

1736

1205

attribute._dbus_annotations)

1737

1206

except AttributeError:

1738

1207

pass

1739

1740

1208

# Define a creator of a function to call both the

1741

1209

# original and alternate functions, so both the

1742

1210

# original and alternate signals gets sent when

1745

1213

"""This function is a scope container to pass

1746

1214

func1 and func2 to the "call_both" function

1747

1215

outside of its arguments"""

1748

1749

@functools.wraps(func2)

1216

1750

1217

def call_both(*args, **kwargs):

1751

1218

"""This function will emit two D-Bus

1752

1219

signals by calling func1 and func2"""

1753

1220

func1(*args, **kwargs)

1754

1221

func2(*args, **kwargs)

1755

# Make wrapper function look like a D-Bus

1756

# signal

1757

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

1758

if name.startswith("_dbus_"):

1759

setattr(call_both, name, attr)

1760

1222

1761

1223

return call_both

1762

1224

# Create the "call_both" function and add it to

1763

1225

# the class

1773

1235

alt_interface,

1774

1236

attribute._dbus_in_signature,

1775

1237

attribute._dbus_out_signature)

1776

(copy_function(attribute)))

1238

(types.FunctionType(attribute.func_code,

1239

attribute.func_globals,

1240

attribute.func_name,

1241

attribute.func_defaults,

1242

attribute.func_closure)))

1777

1243

# Copy annotations, if any

1778

1244

try:

1779

1245

attr[attrname]._dbus_annotations = dict(

1791

1257

attribute._dbus_access,

1792

1258

attribute._dbus_get_args_options

1793

1259

["byte_arrays"])

1794

(copy_function(attribute)))

1260

(types.FunctionType(

1261

attribute.func_code,

1262

attribute.func_globals,

1263

attribute.func_name,

1264

attribute.func_defaults,

1265

attribute.func_closure)))

1795

1266

# Copy annotations, if any

1796

1267

try:

1797

1268

attr[attrname]._dbus_annotations = dict(

1806

1277

# to the class.

1807

1278

attr[attrname] = (

1808

1279

dbus_interface_annotations(alt_interface)

1809

(copy_function(attribute)))

1280

(types.FunctionType(attribute.func_code,

1281

attribute.func_globals,

1282

attribute.func_name,

1283

attribute.func_defaults,

1284

attribute.func_closure)))

1810

1285

if deprecate:

1811

1286

# Deprecate all alternate interfaces

1812

iname = "_AlternateDBusNames_interface_annotation{}"

1287

iname="_AlternateDBusNames_interface_annotation{}"

1813

1288

for interface_name in interface_names:

1814

1289

1815

1290

@dbus_interface_annotations(interface_name)

1816

1291

def func(self):

1817

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

1818

"true"}

1292

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

1293

"true" }

1819

1294

# Find an unused name

1820

1295

for aname in (iname.format(i)

1821

1296

for i in itertools.count()):

1825

1300

if interface_names:

1826

1301

# Replace the class with a new subclass of it with

1827

1302

# methods, signals, etc. as created above.

1828

if sys.version_info.major == 2:

1829

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

1830

(cls, ), attr)

1831

else:

1832

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

1833

(cls, ), attr)

1303

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

1304

(cls, ), attr)

1834

1305

return cls

1835

1306

1836

1307

return wrapper

1837

1308

1838

1309

1840

1311

"se.bsnet.fukt.Mandos"})

1841

1312

class ClientDBus(Client, DBusObjectWithProperties):

1842

1313

"""A Client class using D-Bus

1843

1314

1844

1315

Attributes:

1845

1316

dbus_object_path: dbus.ObjectPath

1846

1317

bus: dbus.SystemBus()

1847

1318

"""

1848

1319

1849

1320

runtime_expansions = (Client.runtime_expansions

1850

1321

+ ("dbus_object_path", ))

1851

1322

1852

1323

_interface = "se.recompile.Mandos.Client"

1853

1324

1854

1325

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

1855

1856

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

1326

1327

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

1857

1328

self.bus = bus

1858

1329

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

1859

1330

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

1865

1336

"/clients/" + client_object_name)

1866

1337

DBusObjectWithProperties.__init__(self, self.bus,

1867

1338

self.dbus_object_path)

1868

1339

1869

1340

def notifychangeproperty(transform_func, dbus_name,

1870

1341

type_func=lambda x: x,

1871

1342

variant_level=1,

1873

1344

_interface=_interface):

1874

1345

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

1875

1346

its changes to DBus.

1876

1347

1877

1348

transform_fun: Function that takes a value and a variant_level

1878

1349

and transforms it to a D-Bus type.

1879

1350

dbus_name: D-Bus name of the variable

1882

1353

variant_level: D-Bus variant level. Default: 1

1883

1354

"""

1884

1355

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

1885

1356

1886

1357

def setter(self, value):

1887

1358

if hasattr(self, "dbus_object_path"):

1888

1359

if (not hasattr(self, attrname) or

1895

1366

else:

1896

1367

dbus_value = transform_func(

1897

1368

type_func(value),

1898

variant_level=variant_level)

1369

variant_level = variant_level)

1899

1370

self.PropertyChanged(dbus.String(dbus_name),

1900

1371

dbus_value)

1901

1372

self.PropertiesChanged(

1902

1373

_interface,

1903

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

1904

dbus_value}),

1374

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

1375

dbus_value }),

1905

1376

dbus.Array())

1906

1377

setattr(self, attrname, value)

1907

1378

1908

1379

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

1909

1380

1910

1381

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1911

1382

approvals_pending = notifychangeproperty(dbus.Boolean,

1912

1383

"ApprovalPending",

1913

type_func=bool)

1384

type_func = bool)

1914

1385

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

1915

1386

last_enabled = notifychangeproperty(datetime_to_dbus,

1916

1387

"LastEnabled")

1917

1388

checker = notifychangeproperty(

1918

1389

dbus.Boolean, "CheckerRunning",

1919

type_func=lambda checker: checker is not None)

1390

type_func = lambda checker: checker is not None)

1920

1391

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1921

1392

"LastCheckedOK")

1922

1393

last_checker_status = notifychangeproperty(dbus.Int16,

1927

1398

"ApprovedByDefault")

1928

1399

approval_delay = notifychangeproperty(

1929

1400

dbus.UInt64, "ApprovalDelay",

1930

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

1401

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

1931

1402

approval_duration = notifychangeproperty(

1932

1403

dbus.UInt64, "ApprovalDuration",

1933

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

1404

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

1934

1405

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

1935

1406

timeout = notifychangeproperty(

1936

1407

dbus.UInt64, "Timeout",

1937

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

1408

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

1938

1409

extended_timeout = notifychangeproperty(

1939

1410

dbus.UInt64, "ExtendedTimeout",

1940

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

1411

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

1941

1412

interval = notifychangeproperty(

1942

1413

dbus.UInt64, "Interval",

1943

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

1414

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

1944

1415

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

1945

1416

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

1946

1417

invalidate_only=True)

1947

1418

1948

1419

del notifychangeproperty

1949

1420

1950

1421

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

1951

1422

try:

1952

1423

self.remove_from_connection()

1955

1426

if hasattr(DBusObjectWithProperties, "__del__"):

1956

1427

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

1957

1428

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

1958

1429

1959

1430

def checker_callback(self, source, condition,

1960

1431

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

1961

1432

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

1977

1448

| self.last_checker_signal),

1978

1449

dbus.String(command))

1979

1450

return ret

1980

1451

1981

1452

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

1982

1453

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

1983

1454

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

1987

1458

# Emit D-Bus signal

1988

1459

self.CheckerStarted(self.current_checker_command)

1989

1460

return r

1990

1461

1991

1462

def _reset_approved(self):

1992

1463

self.approved = None

1993

1464

return False

1994

1465

1995

1466

def approve(self, value=True):

1996

1467

self.approved = value

1997

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

1998

* 1000), self._reset_approved)

1468

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

1469

* 1000), self._reset_approved)

1999

1470

self.send_changedstate()

2000

2001

# D-Bus methods, signals & properties

2002

2003

# Interfaces

2004

2005

# Signals

2006

1471

1472

## D-Bus methods, signals & properties

1473

1474

## Interfaces

1475

1476

## Signals

1477

2007

1478

# CheckerCompleted - signal

2008

1479

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

2009

1480

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

2010

1481

"D-Bus signal"

2011

1482

pass

2012

1483

2013

1484

# CheckerStarted - signal

2014

1485

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

2015

1486

def CheckerStarted(self, command):

2016

1487

"D-Bus signal"

2017

1488

pass

2018

1489

2019

1490

# PropertyChanged - signal

2020

1491

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

2021

1492

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

2022

1493

def PropertyChanged(self, property, value):

2023

1494

"D-Bus signal"

2024

1495

pass

2025

1496

2026

1497

# GotSecret - signal

2027

1498

@dbus.service.signal(_interface)

2028

1499

def GotSecret(self):

2031

1502

server to mandos-client

2032

1503

"""

2033

1504

pass

2034

1505

2035

1506

# Rejected - signal

2036

1507

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

2037

1508

def Rejected(self, reason):

2038

1509

"D-Bus signal"

2039

1510

pass

2040

1511

2041

1512

# NeedApproval - signal

2042

1513

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

2043

1514

def NeedApproval(self, timeout, default):

2044

1515

"D-Bus signal"

2045

1516

return self.need_approval()

2046

2047

# Methods

2048

1517

1518

## Methods

1519

2049

1520

# Approve - method

2050

1521

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

2051

1522

def Approve(self, value):

2052

1523

self.approve(value)

2053

1524

2054

1525

# CheckedOK - method

2055

1526

@dbus.service.method(_interface)

2056

1527

def CheckedOK(self):

2057

1528

self.checked_ok()

2058

1529

2059

1530

# Enable - method

2060

1531

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

2061

1532

@dbus.service.method(_interface)

2062

1533

def Enable(self):

2063

1534

"D-Bus method"

2064

1535

self.enable()

2065

1536

2066

1537

# StartChecker - method

2067

1538

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

2068

1539

@dbus.service.method(_interface)

2069

1540

def StartChecker(self):

2070

1541

"D-Bus method"

2071

1542

self.start_checker()

2072

1543

2073

1544

# Disable - method

2074

1545

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

2075

1546

@dbus.service.method(_interface)

2076

1547

def Disable(self):

2077

1548

"D-Bus method"

2078

1549

self.disable()

2079

1550

2080

1551

# StopChecker - method

2081

1552

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

2082

1553

@dbus.service.method(_interface)

2083

1554

def StopChecker(self):

2084

1555

self.stop_checker()

2085

2086

# Properties

2087

1556

1557

## Properties

1558

2088

1559

# ApprovalPending - property

2089

1560

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

2090

1561

def ApprovalPending_dbus_property(self):

2091

1562

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

2092

1563

2093

1564

# ApprovedByDefault - property

2094

1565

@dbus_service_property(_interface,

2095

1566

signature="b",

2098

1569

if value is None: # get

2099

1570

return dbus.Boolean(self.approved_by_default)

2100

1571

self.approved_by_default = bool(value)

2101

1572

2102

1573

# ApprovalDelay - property

2103

1574

@dbus_service_property(_interface,

2104

1575

signature="t",

2108

1579

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

2109

1580

* 1000)

2110

1581

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

2111

1582

2112

1583

# ApprovalDuration - property

2113

1584

@dbus_service_property(_interface,

2114

1585

signature="t",

2118

1589

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

2119

1590

* 1000)

2120

1591

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

2121

1592

2122

1593

# Name - property

2123

1594

@dbus_annotations(

2124

1595

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

2125

1596

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

2126

1597

def Name_dbus_property(self):

2127

1598

return dbus.String(self.name)

2128

2129

# KeyID - property

2130

@dbus_annotations(

2131

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

2132

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

2133

def KeyID_dbus_property(self):

2134

return dbus.String(self.key_id)

2135

1599

2136

1600

# Fingerprint - property

2137

1601

@dbus_annotations(

2138

1602

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

2139

1603

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

2140

1604

def Fingerprint_dbus_property(self):

2141

1605

return dbus.String(self.fingerprint)

2142

1606

2143

1607

# Host - property

2144

1608

@dbus_service_property(_interface,

2145

1609

signature="s",

2148

1612

if value is None: # get

2149

1613

return dbus.String(self.host)

2150

1614

self.host = str(value)

2151

1615

2152

1616

# Created - property

2153

1617

@dbus_annotations(

2154

1618

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

2155

1619

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

2156

1620

def Created_dbus_property(self):

2157

1621

return datetime_to_dbus(self.created)

2158

1622

2159

1623

# LastEnabled - property

2160

1624

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

2161

1625

def LastEnabled_dbus_property(self):

2162

1626

return datetime_to_dbus(self.last_enabled)

2163

1627

2164

1628

# Enabled - property

2165

1629

@dbus_service_property(_interface,

2166

1630

signature="b",

2172

1636

self.enable()

2173

1637

else:

2174

1638

self.disable()

2175

1639

2176

1640

# LastCheckedOK - property

2177

1641

@dbus_service_property(_interface,

2178

1642

signature="s",

2182

1646

self.checked_ok()

2183

1647

return

2184

1648

return datetime_to_dbus(self.last_checked_ok)

2185

1649

2186

1650

# LastCheckerStatus - property

2187

1651

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

2188

1652

def LastCheckerStatus_dbus_property(self):

2189

1653

return dbus.Int16(self.last_checker_status)

2190

1654

2191

1655

# Expires - property

2192

1656

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

2193

1657

def Expires_dbus_property(self):

2194

1658

return datetime_to_dbus(self.expires)

2195

1659

2196

1660

# LastApprovalRequest - property

2197

1661

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

2198

1662

def LastApprovalRequest_dbus_property(self):

2199

1663

return datetime_to_dbus(self.last_approval_request)

2200

1664

2201

1665

# Timeout - property

2202

1666

@dbus_service_property(_interface,

2203

1667

signature="t",

2218

1682

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

2219

1683

is None):

2220

1684

return

2221

GLib.source_remove(self.disable_initiator_tag)

2222

self.disable_initiator_tag = GLib.timeout_add(

1685

gobject.source_remove(self.disable_initiator_tag)

1686

self.disable_initiator_tag = gobject.timeout_add(

2223

1687

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

2224

1688

self.disable)

2225

1689

2226

1690

# ExtendedTimeout - property

2227

1691

@dbus_service_property(_interface,

2228

1692

signature="t",

2232

1696

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

2233

1697

* 1000)

2234

1698

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

2235

1699

2236

1700

# Interval - property

2237

1701

@dbus_service_property(_interface,

2238

1702

signature="t",

2245

1709

return

2246

1710

if self.enabled:

2247

1711

# Reschedule checker run

2248

GLib.source_remove(self.checker_initiator_tag)

2249

self.checker_initiator_tag = GLib.timeout_add(

1712

gobject.source_remove(self.checker_initiator_tag)

1713

self.checker_initiator_tag = gobject.timeout_add(

2250

1714

value, self.start_checker)

2251

self.start_checker() # Start one now, too

2252

1715

self.start_checker() # Start one now, too

1716

2253

1717

# Checker - property

2254

1718

@dbus_service_property(_interface,

2255

1719

signature="s",

2258

1722

if value is None: # get

2259

1723

return dbus.String(self.checker_command)

2260

1724

self.checker_command = str(value)

2261

1725

2262

1726

# CheckerRunning - property

2263

1727

@dbus_service_property(_interface,

2264

1728

signature="b",

2270

1734

self.start_checker()

2271

1735

else:

2272

1736

self.stop_checker()

2273

1737

2274

1738

# ObjectPath - property

2275

1739

@dbus_annotations(

2276

1740

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

2277

1741

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

2278

1742

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

2279

1743

def ObjectPath_dbus_property(self):

2280

return self.dbus_object_path # is already a dbus.ObjectPath

2281

1744

return self.dbus_object_path # is already a dbus.ObjectPath

1745

2282

1746

# Secret = property

2283

1747

@dbus_annotations(

2284

1748

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

2289

1753

byte_arrays=True)

2290

1754

def Secret_dbus_property(self, value):

2291

1755

self.secret = bytes(value)

2292

1756

2293

1757

del _interface

2294

1758

2295

1759

2296

class ProxyClient:

2297

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

1760

class ProxyClient(object):

1761

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

2298

1762

self._pipe = child_pipe

2299

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

1763

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

2300

1764

if not self._pipe.recv():

2301

raise KeyError(key_id or fpr)

2302

1765

raise KeyError(fpr)

1766

2303

1767

def __getattribute__(self, name):

2304

if name == "_pipe":

1768

if name == '_pipe':

2305

1769

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

2306

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

1770

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

2307

1771

data = self._pipe.recv()

2308

if data[0] == "data":

1772

if data[0] == 'data':

2309

1773

return data[1]

2310

if data[0] == "function":

2311

1774

if data[0] == 'function':

1775

2312

1776

def func(*args, **kwargs):

2313

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

1777

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

2314

1778

return self._pipe.recv()[1]

2315

1779

2316

1780

return func

2317

1781

2318

1782

def __setattr__(self, name, value):

2319

if name == "_pipe":

1783

if name == '_pipe':

2320

1784

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

2321

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

1785

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

2322

1786

2323

1787

2324

1788

class ClientHandler(socketserver.BaseRequestHandler, object):

2325

1789

"""A class to handle client connections.

2326

1790

2327

1791

Instantiated once for each connection to handle it.

2328

1792

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

2329

1793

2330

1794

def handle(self):

2331

1795

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

2332

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

2333

str(self.client_address))

2334

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

2335

2336

session = gnutls.ClientSession(self.request)

2337

2338

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

2339

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

2340

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

2341

# "+DHE-DSS"))

1796

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

1797

str(self.client_address))

1798

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

1799

self.server.child_pipe.fileno())

1800

1801

session = gnutls.connection.ClientSession(

1802

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

1803

1804

# Note: gnutls.connection.X509Credentials is really a

1805

# generic GnuTLS certificate credentials object so long as

1806

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

1807

# here despite using OpenPGP certificates.

1808

1809

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

1810

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

1811

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

1812

# "+DHE-DSS"))

2342

1813

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

2343

1814

priority = self.server.gnutls_priority

2344

1815

if priority is None:

2345

1816

priority = "NORMAL"

2346

gnutls.priority_set_direct(session,

2347

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

2348

1817

gnutls.library.functions.gnutls_priority_set_direct(

1818

session._c_object, priority, None)

1819

2349

1820

# Start communication using the Mandos protocol

2350

1821

# Get protocol number

2351

1822

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

2352

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

1823

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

2353

1824

try:

2354

1825

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

2355

1826

raise RuntimeError(line)

2356

1827

except (ValueError, IndexError, RuntimeError) as error:

2357

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

1828

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

2358

1829

return

2359

1830

2360

1831

# Start GnuTLS connection

2361

1832

try:

2362

1833

session.handshake()

2363

except gnutls.Error as error:

2364

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

1834

except gnutls.errors.GNUTLSError as error:

1835

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

2365

1836

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

2366

1837

# established. Just abandon the request.

2367

1838

return

2368

log.debug("Handshake succeeded")

2369

1839

logger.debug("Handshake succeeded")

1840

2370

1841

approval_required = False

2371

1842

try:

2372

if gnutls.has_rawpk:

2373

fpr = b""

2374

try:

2375

key_id = self.key_id(

2376

self.peer_certificate(session))

2377

except (TypeError, gnutls.Error) as error:

2378

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

2379

return

2380

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

2381

key_id.decode("utf-8",

2382

errors="replace"))

2383

2384

else:

2385

key_id = b""

2386

try:

2387

fpr = self.fingerprint(

2388

self.peer_certificate(session))

2389

except (TypeError, gnutls.Error) as error:

2390

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

2391

return

2392

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

2393

2394

try:

2395

client = ProxyClient(child_pipe, key_id, fpr,

1843

try:

1844

fpr = self.fingerprint(

1845

self.peer_certificate(session))

1846

except (TypeError,

1847

gnutls.errors.GNUTLSError) as error:

1848

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

1849

return

1850

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

1851

1852

try:

1853

client = ProxyClient(child_pipe, fpr,

2396

1854

self.client_address)

2397

1855

except KeyError:

2398

1856

return

2399

1857

2400

1858

if client.approval_delay:

2401

1859

delay = client.approval_delay

2402

1860

client.approvals_pending += 1

2403

1861

approval_required = True

2404

1862

2405

1863

while True:

2406

1864

if not client.enabled:

2407

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

1865

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

1866

client.name)

2408

1867

if self.server.use_dbus:

2409

1868

# Emit D-Bus signal

2410

1869

client.Rejected("Disabled")

2411

1870

return

2412

1871

2413

1872

if client.approved or not client.approval_delay:

2414

# We are approved or approval is disabled

1873

#We are approved or approval is disabled

2415

1874

break

2416

1875

elif client.approved is None:

2417

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

2418

client.name)

1876

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

1877

client.name)

2419

1878

if self.server.use_dbus:

2420

1879

# Emit D-Bus signal

2421

1880

client.NeedApproval(

2422

1881

client.approval_delay.total_seconds()

2423

1882

* 1000, client.approved_by_default)

2424

1883

else:

2425

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

2426

client.name)

1884

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

1885

client.name)

2427

1886

if self.server.use_dbus:

2428

1887

# Emit D-Bus signal

2429

1888

client.Rejected("Denied")

2430

1889

return

2431

2432

# wait until timeout or approved

1890

1891

#wait until timeout or approved

2433

1892

time = datetime.datetime.now()

2434

1893

client.changedstate.acquire()

2435

1894

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

2437

1896

time2 = datetime.datetime.now()

2438

1897

if (time2 - time) >= delay:

2439

1898

if not client.approved_by_default:

2440

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

2441

" waiting for approval",

2442

client.name)

1899

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

1900

" waiting for approval",

1901

client.name)

2443

1902

if self.server.use_dbus:

2444

1903

# Emit D-Bus signal

2445

1904

client.Rejected("Approval timed out")

2448

1907

break

2449

1908

else:

2450

1909

delay -= time2 - time

2451

2452

try:

2453

session.send(client.secret)

2454

except gnutls.Error as error:

2455

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

2456

return

2457

2458

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

1910

1911

sent_size = 0

1912

while sent_size < len(client.secret):

1913

try:

1914

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

1915

except gnutls.errors.GNUTLSError as error:

1916

logger.warning("gnutls send failed",

1917

exc_info=error)

1918

return

1919

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

1920

len(client.secret) - (sent_size

1921

+ sent))

1922

sent_size += sent

1923

1924

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

2459

1925

# bump the timeout using extended_timeout

2460

1926

client.bump_timeout(client.extended_timeout)

2461

1927

if self.server.use_dbus:

2462

1928

# Emit D-Bus signal

2463

1929

client.GotSecret()

2464

1930

2465

1931

finally:

2466

1932

if approval_required:

2467

1933

client.approvals_pending -= 1

2468

1934

try:

2469

1935

session.bye()

2470

except gnutls.Error as error:

2471

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

2472

1936

except gnutls.errors.GNUTLSError as error:

1937

logger.warning("GnuTLS bye failed",

1938

exc_info=error)

1939

2473

1940

@staticmethod

2474

1941

def peer_certificate(session):

2475

"Return the peer's certificate as a bytestring"

2476

try:

2477

cert_type = gnutls.certificate_type_get2(

2478

session, gnutls.CTYPE_PEERS)

2479

except AttributeError:

2480

cert_type = gnutls.certificate_type_get(session)

2481

if gnutls.has_rawpk:

2482

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2483

else:

2484

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2485

# If not a valid certificate type...

2486

if cert_type not in valid_cert_types:

2487

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

2488

valid_cert_types)

2489

# ...return invalid data

2490

return b""

1942

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

1943

# If not an OpenPGP certificate...

1944

if (gnutls.library.functions.gnutls_certificate_type_get(

1945

session._c_object)

1946

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1947

# ...do the normal thing

1948

return session.peer_certificate

2491

1949

list_size = ctypes.c_uint(1)

2492

cert_list = (gnutls.certificate_get_peers

2493

(session, ctypes.byref(list_size)))

1950

cert_list = (gnutls.library.functions

1951

.gnutls_certificate_get_peers

1952

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

2494

1953

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

2495

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

1954

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

1955

" certificate")

2496

1956

if list_size.value == 0:

2497

1957

return None

2498

1958

cert = cert_list[0]

2499

1959

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

2500

2501

@staticmethod

2502

def key_id(certificate):

2503

"Convert a certificate bytestring to a hexdigit key ID"

2504

# New GnuTLS "datum" with the public key

2505

datum = gnutls.datum_t(

2506

ctypes.cast(ctypes.c_char_p(certificate),

2507

ctypes.POINTER(ctypes.c_ubyte)),

2508

ctypes.c_uint(len(certificate)))

2509

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

2510

# New empty GnuTLS certificate

2511

pubkey = gnutls.pubkey_t()

2512

gnutls.pubkey_init(ctypes.byref(pubkey))

2513

# Import the raw public key into the certificate

2514

gnutls.pubkey_import(pubkey,

2515

ctypes.byref(datum),

2516

gnutls.X509_FMT_DER)

2517

# New buffer for the key ID

2518

buf = ctypes.create_string_buffer(32)

2519

buf_len = ctypes.c_size_t(len(buf))

2520

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

2521

gnutls.pubkey_get_key_id(

2522

pubkey,

2523

gnutls.KEYID_USE_SHA256,

2524

ctypes.cast(ctypes.byref(buf),

2525

ctypes.POINTER(ctypes.c_ubyte)),

2526

ctypes.byref(buf_len))

2527

# Deinit the certificate

2528

gnutls.pubkey_deinit(pubkey)

2529

2530

# Convert the buffer to a Python bytestring

2531

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

2532

# Convert the bytestring to hexadecimal notation

2533

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

2534

return hex_key_id

2535

1960

2536

1961

@staticmethod

2537

1962

def fingerprint(openpgp):

2538

1963

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2539

1964

# New GnuTLS "datum" with the OpenPGP public key

2540

datum = gnutls.datum_t(

1965

datum = gnutls.library.types.gnutls_datum_t(

2541

1966

ctypes.cast(ctypes.c_char_p(openpgp),

2542

1967

ctypes.POINTER(ctypes.c_ubyte)),

2543

1968

ctypes.c_uint(len(openpgp)))

2544

1969

# New empty GnuTLS certificate

2545

crt = gnutls.openpgp_crt_t()

2546

gnutls.openpgp_crt_init(ctypes.byref(crt))

1970

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1971

gnutls.library.functions.gnutls_openpgp_crt_init(

1972

ctypes.byref(crt))

2547

1973

# Import the OpenPGP public key into the certificate

2548

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

2549

gnutls.OPENPGP_FMT_RAW)

1974

gnutls.library.functions.gnutls_openpgp_crt_import(

1975

crt, ctypes.byref(datum),

1976

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

2550

1977

# Verify the self signature in the key

2551

1978

crtverify = ctypes.c_uint()

2552

gnutls.openpgp_crt_verify_self(crt, 0,

2553

ctypes.byref(crtverify))

1979

gnutls.library.functions.gnutls_openpgp_crt_verify_self(

1980

crt, 0, ctypes.byref(crtverify))

2554

1981

if crtverify.value != 0:

2555

gnutls.openpgp_crt_deinit(crt)

2556

raise gnutls.CertificateSecurityError(code

2557

=crtverify.value)

1982

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1983

raise gnutls.errors.CertificateSecurityError(

1984

"Verify failed")

2558

1985

# New buffer for the fingerprint

2559

1986

buf = ctypes.create_string_buffer(20)

2560

1987

buf_len = ctypes.c_size_t()

2561

1988

# Get the fingerprint from the certificate into the buffer

2562

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

2563

ctypes.byref(buf_len))

1989

gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(

1990

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

2564

1991

# Deinit the certificate

2565

gnutls.openpgp_crt_deinit(crt)

1992

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2566

1993

# Convert the buffer to a Python bytestring

2567

1994

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

2568

1995

# Convert the bytestring to hexadecimal notation

2570

1997

return hex_fpr

2571

1998

2572

1999

2573

class MultiprocessingMixIn:

2000

class MultiprocessingMixIn(object):

2574

2001

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

2575

2002

2576

2003

def sub_process_main(self, request, address):

2577

2004

try:

2578

2005

self.finish_request(request, address)

2579

2006

except Exception:

2580

2007

self.handle_error(request, address)

2581

2008

self.close_request(request)

2582

2009

2583

2010

def process_request(self, request, address):

2584

2011

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

2585

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

2586

args=(request, address))

2012

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

2013

args = (request, address))

2587

2014

proc.start()

2588

2015

return proc

2589

2016

2590

2017

2591

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

2018

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2592

2019

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

2593

2020

2594

2021

def process_request(self, request, client_address):

2595

2022

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

2596

2023

2597

2024

This function creates a new pipe in self.pipe

2598

2025

"""

2599

2026

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2600

2027

2601

2028

proc = MultiprocessingMixIn.process_request(self, request,

2602

2029

client_address)

2603

2030

self.child_pipe.close()

2604

2031

self.add_pipe(parent_pipe, proc)

2605

2032

2606

2033

def add_pipe(self, parent_pipe, proc):

2607

2034

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

2608

2035

raise NotImplementedError()

2609

2036

2610

2037

2611

2038

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2612

socketserver.TCPServer):

2613

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

2614

2039

socketserver.TCPServer, object):

2040

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

2041

2615

2042

Attributes:

2616

2043

enabled: Boolean; whether this server is activated yet

2617

2044

interface: None or a network interface name (string)

2618

2045

use_ipv6: Boolean; to use IPv6 or not

2619

2046

"""

2620

2047

2621

2048

def __init__(self, server_address, RequestHandlerClass,

2622

2049

interface=None,

2623

2050

use_ipv6=True,

2633

2060

self.socketfd = socketfd

2634

2061

# Save the original socket.socket() function

2635

2062

self.socket_socket = socket.socket

2636

2637

2063

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

2638

#

2064

#

2639

2065

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

2640

2066

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

2641

2067

# patching socket.socket.)

2642

#

2068

#

2643

2069

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

2644

2070

@functools.wraps(socket.socket)

2645

2071

def socket_wrapper(*args, **kwargs):

2657

2083

# socket_wrapper(), if socketfd was set.

2658

2084

socketserver.TCPServer.__init__(self, server_address,

2659

2085

RequestHandlerClass)

2660

2086

2661

2087

def server_bind(self):

2662

2088

"""This overrides the normal server_bind() function

2663

2089

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

2664

2090

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

2665

global SO_BINDTODEVICE

2666

2091

if self.interface is not None:

2667

2092

if SO_BINDTODEVICE is None:

2668

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

2669

# common enough.

2670

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

2671

SO_BINDTODEVICE = 25

2672

try:

2673

self.socket.setsockopt(

2674

socket.SOL_SOCKET, SO_BINDTODEVICE,

2675

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

2676

except socket.error as error:

2677

if error.errno == errno.EPERM:

2678

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

2679

self.interface)

2680

elif error.errno == errno.ENOPROTOOPT:

2681

log.error("SO_BINDTODEVICE not available; cannot"

2682

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

2683

elif error.errno == errno.ENODEV:

2684

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

2685

" bind", self.interface)

2686

else:

2687

raise

2093

logger.error("SO_BINDTODEVICE does not exist;"

2094

" cannot bind to interface %s",

2095

self.interface)

2096

else:

2097

try:

2098

self.socket.setsockopt(

2099

socket.SOL_SOCKET, SO_BINDTODEVICE,

2100

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

2101

except socket.error as error:

2102

if error.errno == errno.EPERM:

2103

logger.error("No permission to bind to"

2104

" interface %s", self.interface)

2105

elif error.errno == errno.ENOPROTOOPT:

2106

logger.error("SO_BINDTODEVICE not available;"

2107

" cannot bind to interface %s",

2108

self.interface)

2109

elif error.errno == errno.ENODEV:

2110

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

2111

" cannot bind", self.interface)

2112

else:

2113

raise

2688

2114

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

2689

2115

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

2690

if self.server_address[1]:

2691

self.allow_reuse_address = True

2692

2116

if not self.server_address[0]:

2693

2117

if self.address_family == socket.AF_INET6:

2694

any_address = "::" # in6addr_any

2118

any_address = "::" # in6addr_any

2695

2119

else:

2696

any_address = "0.0.0.0" # INADDR_ANY

2120

any_address = "0.0.0.0" # INADDR_ANY

2697

2121

self.server_address = (any_address,

2698

2122

self.server_address[1])

2699

2123

elif not self.server_address[1]:

2709

2133

2710

2134

class MandosServer(IPv6_TCPServer):

2711

2135

"""Mandos server.

2712

2136

2713

2137

Attributes:

2714

2138

clients: set of Client objects

2715

2139

gnutls_priority GnuTLS priority string

2716

2140

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

2717

2718

Assumes a GLib.MainLoop event loop.

2141

2142

Assumes a gobject.MainLoop event loop.

2719

2143

"""

2720

2144

2721

2145

def __init__(self, server_address, RequestHandlerClass,

2722

2146

interface=None,

2723

2147

use_ipv6=True,

2733

2157

self.gnutls_priority = gnutls_priority

2734

2158

IPv6_TCPServer.__init__(self, server_address,

2735

2159

RequestHandlerClass,

2736

interface=interface,

2737

use_ipv6=use_ipv6,

2738

socketfd=socketfd)

2739

2160

interface = interface,

2161

use_ipv6 = use_ipv6,

2162

socketfd = socketfd)

2163

2740

2164

def server_activate(self):

2741

2165

if self.enabled:

2742

2166

return socketserver.TCPServer.server_activate(self)

2743

2167

2744

2168

def enable(self):

2745

2169

self.enabled = True

2746

2170

2747

2171

def add_pipe(self, parent_pipe, proc):

2748

2172

# Call "handle_ipc" for both data and EOF events

2749

GLib.io_add_watch(

2750

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

2751

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

2173

gobject.io_add_watch(

2174

parent_pipe.fileno(),

2175

gobject.IO_IN | gobject.IO_HUP,

2752

2176

functools.partial(self.handle_ipc,

2753

parent_pipe=parent_pipe,

2754

proc=proc))

2755

2177

parent_pipe = parent_pipe,

2178

proc = proc))

2179

2756

2180

def handle_ipc(self, source, condition,

2757

2181

parent_pipe=None,

2758

proc=None,

2182

proc = None,

2759

2183

client_object=None):

2760

2184

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

2761

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

2185

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

2762

2186

# Wait for other process to exit

2763

2187

proc.join()

2764

2188

return False

2765

2189

2766

2190

# Read a request from the child

2767

2191

request = parent_pipe.recv()

2768

2192

command = request[0]

2769

2770

if command == "init":

2771

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

2772

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

2773

address = request[3]

2774

2775

for c in self.clients.values():

2776

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2777

"27AE41E4649B934CA495991B7852B855"):

2778

continue

2779

if key_id and c.key_id == key_id:

2780

client = c

2781

break

2782

if fpr and c.fingerprint == fpr:

2193

2194

if command == 'init':

2195

fpr = request[1]

2196

address = request[2]

2197

2198

for c in self.clients.itervalues():

2199

if c.fingerprint == fpr:

2783

2200

client = c

2784

2201

break

2785

2202

else:

2786

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

2787

" %s", key_id or fpr, address)

2203

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

2204

"dress: %s", fpr, address)

2788

2205

if self.use_dbus:

2789

2206

# Emit D-Bus signal

2790

mandos_dbus_service.ClientNotFound(key_id or fpr,

2207

mandos_dbus_service.ClientNotFound(fpr,

2791

2208

address[0])

2792

2209

parent_pipe.send(False)

2793

2210

return False

2794

2795

GLib.io_add_watch(

2796

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

2797

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

2211

2212

gobject.io_add_watch(

2213

parent_pipe.fileno(),

2214

gobject.IO_IN | gobject.IO_HUP,

2798

2215

functools.partial(self.handle_ipc,

2799

parent_pipe=parent_pipe,

2800

proc=proc,

2801

client_object=client))

2216

parent_pipe = parent_pipe,

2217

proc = proc,

2218

client_object = client))

2802

2219

parent_pipe.send(True)

2803

2220

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

2804

2221

# same fileno

2805

2222

return False

2806

if command == "funcall":

2223

if command == 'funcall':

2807

2224

funcname = request[1]

2808

2225

args = request[2]

2809

2226

kwargs = request[3]

2810

2811

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

2227

2228

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

2812

2229

funcname)(*args,

2813

2230

**kwargs)))

2814

2815

if command == "getattr":

2231

2232

if command == 'getattr':

2816

2233

attrname = request[1]

2817

2234

if isinstance(client_object.__getattribute__(attrname),

2818

collections.abc.Callable):

2819

parent_pipe.send(("function", ))

2235

collections.Callable):

2236

parent_pipe.send(('function', ))

2820

2237

else:

2821

2238

parent_pipe.send((

2822

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

2823

2824

if command == "setattr":

2239

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

2240

2241

if command == 'setattr':

2825

2242

attrname = request[1]

2826

2243

value = request[2]

2827

2244

setattr(client_object, attrname, value)

2828

2245

2829

2246

return True

2830

2247

2831

2248

2832

2249

def rfc3339_duration_to_delta(duration):

2833

2250

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

2834

2835

>>> timedelta = datetime.timedelta

2836

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

2837

True

2838

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

2839

True

2840

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

2841

True

2842

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

2843

True

2844

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

2845

True

2846

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

2847

True

2848

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

2849

True

2850

>>> del timedelta

2251

2252

>>> rfc3339_duration_to_delta("P7D")

2253

datetime.timedelta(7)

2254

>>> rfc3339_duration_to_delta("PT60S")

2255

datetime.timedelta(0, 60)

2256

>>> rfc3339_duration_to_delta("PT60M")

2257

datetime.timedelta(0, 3600)

2258

>>> rfc3339_duration_to_delta("PT24H")

2259

datetime.timedelta(1)

2260

>>> rfc3339_duration_to_delta("P1W")

2261

datetime.timedelta(7)

2262

>>> rfc3339_duration_to_delta("PT5M30S")

2263

datetime.timedelta(0, 330)

2264

>>> rfc3339_duration_to_delta("P1DT3M20S")

2265

datetime.timedelta(1, 200)

2851

2266

"""

2852

2267

2853

2268

# Parsing an RFC 3339 duration with regular expressions is not

2854

2269

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

2855

2270

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

2856

2271

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

2857

2272

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

2858

2273

# avoid excessive use of external libraries.

2859

2274

2860

2275

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

2861

2276

Token = collections.namedtuple("Token", (

2862

2277

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

2895

2310

frozenset((token_year, token_month,

2896

2311

token_day, token_time,

2897

2312

token_week)))

2898

# Define starting values:

2899

# Value so far

2900

value = datetime.timedelta()

2313

# Define starting values

2314

value = datetime.timedelta() # Value so far

2901

2315

found_token = None

2902

# Following valid tokens

2903

followers = frozenset((token_duration, ))

2904

# String left to parse

2905

s = duration

2316

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

2317

s = duration # String left to parse

2906

2318

# Loop until end token is found

2907

2319

while found_token is not token_end:

2908

2320

# Search for any currently valid tokens

2932

2344

2933

2345

def string_to_delta(interval):

2934

2346

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

2935

2936

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

2937

True

2938

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

2939

True

2940

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

2941

True

2942

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

2943

True

2944

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

2945

True

2946

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

2947

True

2347

2348

>>> string_to_delta('7d')

2349

datetime.timedelta(7)

2350

>>> string_to_delta('60s')

2351

datetime.timedelta(0, 60)

2352

>>> string_to_delta('60m')

2353

datetime.timedelta(0, 3600)

2354

>>> string_to_delta('24h')

2355

datetime.timedelta(1)

2356

>>> string_to_delta('1w')

2357

datetime.timedelta(7)

2358

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

2359

datetime.timedelta(0, 330)

2948

2360

"""

2949

2361

2950

2362

try:

2951

2363

return rfc3339_duration_to_delta(interval)

2952

2364

except ValueError:

2953

2365

pass

2954

2366

2955

2367

timevalue = datetime.timedelta(0)

2956

2368

for s in interval.split():

2957

2369

try:

2975

2387

return timevalue

2976

2388

2977

2389

2978

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

2390

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

2979

2391

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

2980

2392

2981

2393

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

2982

2394

if os.fork():

2983

2395

sys.exit()

3001

2413

3002

2414

3003

2415

def main():

3004

2416

3005

2417

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

3006

2418

# Parsing of options, both command line and config file

3007

2419

3008

2420

parser = argparse.ArgumentParser()

3009

2421

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

3010

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

2422

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

3011

2423

help="show version number and exit")

3012

2424

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

3013

2425

help="Bind to interface IF")

3049

2461

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

3050

2462

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

3051

2463

default=None)

3052

2464

3053

2465

options = parser.parse_args()

3054

2466

2467

if options.check:

2468

import doctest

2469

fail_count, test_count = doctest.testmod()

2470

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

2471

3055

2472

# Default values for config file for server-global settings

3056

if gnutls.has_rawpk:

3057

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

3058

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

3059

else:

3060

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

3061

":+SIGN-DSA-SHA256")

3062

server_defaults = {"interface": "",

3063

"address": "",

3064

"port": "",

3065

"debug": "False",

3066

"priority": priority,

3067

"servicename": "Mandos",

3068

"use_dbus": "True",

3069

"use_ipv6": "True",

3070

"debuglevel": "",

3071

"restore": "True",

3072

"socket": "",

3073

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

3074

"foreground": "False",

3075

"zeroconf": "True",

3076

}

3077

del priority

3078

2473

server_defaults = { "interface": "",

2474

"address": "",

2475

"port": "",

2476

"debug": "False",

2477

"priority":

2478

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

2479

":+SIGN-DSA-SHA256",

2480

"servicename": "Mandos",

2481

"use_dbus": "True",

2482

"use_ipv6": "True",

2483

"debuglevel": "",

2484

"restore": "True",

2485

"socket": "",

2486

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

2487

"foreground": "False",

2488

"zeroconf": "True",

2489

}

2490

3079

2491

# Parse config file for server-global settings

3080

server_config = configparser.ConfigParser(server_defaults)

2492

server_config = configparser.SafeConfigParser(server_defaults)

3081

2493

del server_defaults

3082

2494

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

3083

# Convert the ConfigParser object to a dict

2495

# Convert the SafeConfigParser object to a dict

3084

2496

server_settings = server_config.defaults()

3085

2497

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

3086

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

3087

"foreground", "zeroconf"):

2498

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

3088

2499

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

3089

2500

option)

3090

2501

if server_settings["port"]:

3100

2511

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

3101

2512

["socket"])

3102

2513

del server_config

3103

2514

3104

2515

# Override the settings from the config file with command line

3105

2516

# options, if set.

3106

2517

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

3124

2535

if server_settings["debug"]:

3125

2536

server_settings["foreground"] = True

3126

2537

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

3127

2538

3128

2539

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

3129

2540

3130

2541

if (not server_settings["zeroconf"]

3131

2542

and not (server_settings["port"]

3132

2543

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

3133

2544

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

3134

2545

3135

2546

# For convenience

3136

2547

debug = server_settings["debug"]

3137

2548

debuglevel = server_settings["debuglevel"]

3141

2552

stored_state_file)

3142

2553

foreground = server_settings["foreground"]

3143

2554

zeroconf = server_settings["zeroconf"]

3144

2555

3145

2556

if debug:

3146

2557

initlogger(debug, logging.DEBUG)

3147

2558

else:

3150

2561

else:

3151

2562

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

3152

2563

initlogger(debug, level)

3153

2564

3154

2565

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

3155

2566

syslogger.setFormatter(

3156

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

3157

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

2567

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

2568

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

3158

2569

server_settings["servicename"])))

3159

2570

3160

2571

# Parse config file with clients

3161

client_config = configparser.ConfigParser(Client.client_defaults)

2572

client_config = configparser.SafeConfigParser(Client

2573

.client_defaults)

3162

2574

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

3163

2575

"clients.conf"))

3164

2576

3165

2577

global mandos_dbus_service

3166

2578

mandos_dbus_service = None

3167

2579

3168

2580

socketfd = None

3169

2581

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

3170

2582

socketfd = server_settings["socket"]

3184

2596

try:

3185

2597

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

3186

2598

except IOError as e:

3187

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

3188

exc_info=e)

3189

3190

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

3191

("mandos", "mandos"),

3192

("nobody", "nogroup")):

2599

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

2600

exc_info=e)

2601

2602

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

3193

2603

try:

3194

2604

uid = pwd.getpwnam(name).pw_uid

3195

gid = pwd.getpwnam(group).pw_gid

2605

gid = pwd.getpwnam(name).pw_gid

3196

2606

break

3197

2607

except KeyError:

3198

2608

continue

3202

2612

try:

3203

2613

os.setgid(gid)

3204

2614

os.setuid(uid)

3205

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

3206

2615

except OSError as error:

3207

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

3208

os.strerror(error.errno))

3209

2616

if error.errno != errno.EPERM:

3210

2617

raise

3211

2618

3212

2619

if debug:

3213

2620

# Enable all possible GnuTLS debugging

3214

2621

3215

2622

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

3216

2623

# - GnuTLS manual

3217

gnutls.global_set_log_level(11)

3218

3219

@gnutls.log_func

2624

gnutls.library.functions.gnutls_global_set_log_level(11)

2625

2626

@gnutls.library.types.gnutls_log_func

3220

2627

def debug_gnutls(level, string):

3221

log.debug("GnuTLS: %s",

3222

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

3223

3224

gnutls.global_set_log_function(debug_gnutls)

3225

2628

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

2629

2630

gnutls.library.functions.gnutls_global_set_log_function(

2631

debug_gnutls)

2632

3226

2633

# Redirect stdin so all checkers get /dev/null

3227

2634

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

3228

2635

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

3229

2636

if null > 2:

3230

2637

os.close(null)

3231

2638

3232

2639

# Need to fork before connecting to D-Bus

3233

2640

if not foreground:

3234

2641

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

3235

2642

daemon()

3236

3237

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

3238

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

3239

# need to inform GLib that threads will be used.

3240

GLib.threads_init()

3241

2643

2644

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

2645

# need to inform gobject that threads will be used.

2646

gobject.threads_init()

2647

3242

2648

global main_loop

3243

2649

# From the Avahi example code

3244

2650

DBusGMainLoop(set_as_default=True)

3245

main_loop = GLib.MainLoop()

2651

main_loop = gobject.MainLoop()

3246

2652

bus = dbus.SystemBus()

3247

2653

# End of Avahi example code

3248

2654

if use_dbus:

3254

2660

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

3255

2661

do_not_queue=True)

3256

2662

except dbus.exceptions.DBusException as e:

3257

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

2663

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

3258

2664

use_dbus = False

3259

2665

server_settings["use_dbus"] = False

3260

2666

tcp_server.use_dbus = False

3261

2667

if zeroconf:

3262

2668

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3263

2669

service = AvahiServiceToSyslog(

3264

name=server_settings["servicename"],

3265

servicetype="_mandos._tcp",

3266

protocol=protocol,

3267

bus=bus)

2670

name = server_settings["servicename"],

2671

servicetype = "_mandos._tcp",

2672

protocol = protocol,

2673

bus = bus)

3268

2674

if server_settings["interface"]:

3269

2675

service.interface = if_nametoindex(

3270

2676

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

3271

2677

3272

2678

global multiprocessing_manager

3273

2679

multiprocessing_manager = multiprocessing.Manager()

3274

2680

3275

2681

client_class = Client

3276

2682

if use_dbus:

3277

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

3278

2683

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

2684

3279

2685

client_settings = Client.config_parser(client_config)

3280

2686

old_client_settings = {}

3281

2687

clients_data = {}

3282

2688

3283

2689

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

3284

2690

global wnull

3285

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

2691

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

3286

2692

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

3287

2693

# mode

3288

2694

if debug or not foreground:

3289

2695

wnull.close()

3290

2696

3291

2697

# Get client data and settings from last running state.

3292

2698

if server_settings["restore"]:

3293

2699

try:

3294

2700

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

3295

if sys.version_info.major == 2:

3296

clients_data, old_client_settings = pickle.load(

3297

stored_state)

3298

else:

3299

bytes_clients_data, bytes_old_client_settings = (

3300

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

3301

# Fix bytes to strings

3302

# clients_data

3303

# .keys()

3304

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

3305

if isinstance(key, bytes)

3306

else key): value

3307

for key, value in

3308

bytes_clients_data.items()}

3309

del bytes_clients_data

3310

for key in clients_data:

3311

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

3312

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

3313

for k, v in

3314

clients_data[key].items()}

3315

clients_data[key] = value

3316

# .client_structure

3317

value["client_structure"] = [

3318

(s.decode("utf-8")

3319

if isinstance(s, bytes)

3320

else s) for s in

3321

value["client_structure"]]

3322

# .name, .host, and .checker_command

3323

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

3324

if isinstance(value[k], bytes):

3325

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

3326

if "key_id" not in value:

3327

value["key_id"] = ""

3328

elif "fingerprint" not in value:

3329

value["fingerprint"] = ""

3330

# old_client_settings

3331

# .keys()

3332

old_client_settings = {

3333

(key.decode("utf-8")

3334

if isinstance(key, bytes)

3335

else key): value

3336

for key, value in

3337

bytes_old_client_settings.items()}

3338

del bytes_old_client_settings

3339

# .host and .checker_command

3340

for value in old_client_settings.values():

3341

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

3342

if isinstance(value[attribute], bytes):

3343

value[attribute] = (value[attribute]

3344

.decode("utf-8"))

2701

clients_data, old_client_settings = pickle.load(

2702

stored_state)

3345

2703

os.remove(stored_state_path)

3346

2704

except IOError as e:

3347

2705

if e.errno == errno.ENOENT:

3348

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

3349

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

2706

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

2707

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

3350

2708

else:

3351

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

3352

exc_info=e)

2709

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

2710

exc_info=e)

3353

2711

raise

3354

2712

except EOFError as e:

3355

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

3356

exc_info=e)

3357

2713

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

2714

"EOFError:",

2715

exc_info=e)

2716

3358

2717

with PGPEngine() as pgp:

3359

2718

for client_name, client in clients_data.items():

3360

2719

# Skip removed clients

3361

2720

if client_name not in client_settings:

3362

2721

continue

3363

2722

3364

2723

# Decide which value to use after restoring saved state.

3365

2724

# We have three different values: Old config file,

3366

2725

# new config file, and saved state.

3377

2736

client[name] = value

3378

2737

except KeyError:

3379

2738

pass

3380

2739

3381

2740

# Clients who has passed its expire date can still be

3382

2741

# enabled if its last checker was successful. A Client

3383

2742

# whose checker succeeded before we stored its state is

3386

2745

if client["enabled"]:

3387

2746

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

3388

2747

if not client["last_checked_ok"]:

3389

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

3390

" never performed a successful"

3391

" checker", client_name)

2748

logger.warning(

2749

"disabling client {} - Client never "

2750

"performed a successful checker".format(

2751

client_name))

3392

2752

client["enabled"] = False

3393

2753

elif client["last_checker_status"] != 0:

3394

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

3395

" last checker failed with error"

3396

" code %s", client_name,

3397

client["last_checker_status"])

2754

logger.warning(

2755

"disabling client {} - Client last"

2756

" checker failed with error code"

2757

" {}".format(

2758

client_name,

2759

client["last_checker_status"]))

3398

2760

client["enabled"] = False

3399

2761

else:

3400

2762

client["expires"] = (

3401

2763

datetime.datetime.utcnow()

3402

2764

+ client["timeout"])

3403

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

3404

" enabled", client_name)

2765

logger.debug("Last checker succeeded,"

2766

" keeping {} enabled".format(

2767

client_name))

3405

2768

try:

3406

2769

client["secret"] = pgp.decrypt(

3407

2770

client["encrypted_secret"],

3408

2771

client_settings[client_name]["secret"])

3409

2772

except PGPError:

3410

2773

# If decryption fails, we use secret from new settings

3411

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

3412

client_name)

2774

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

2775

client_name))

3413

2776

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

3414

2777

["secret"])

3415

2778

3416

2779

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

3417

2780

for client_name in (set(old_client_settings)

3418

2781

- set(client_settings)):

3420

2783

for client_name in (set(client_settings)

3421

2784

- set(old_client_settings)):

3422

2785

clients_data[client_name] = client_settings[client_name]

3423

2786

3424

2787

# Create all client objects

3425

2788

for client_name, client in clients_data.items():

3426

2789

tcp_server.clients[client_name] = client_class(

3427

name=client_name,

3428

settings=client,

3429

server_settings=server_settings)

3430

2790

name = client_name,

2791

settings = client,

2792

server_settings = server_settings)

2793

3431

2794

if not tcp_server.clients:

3432

log.warning("No clients defined")

3433

2795

logger.warning("No clients defined")

2796

3434

2797

if not foreground:

3435

2798

if pidfile is not None:

3436

2799

pid = os.getpid()

3438

2801

with pidfile:

3439

2802

print(pid, file=pidfile)

3440

2803

except IOError:

3441

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

3442

pidfilename, pid)

2804

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

2805

pidfilename, pid)

3443

2806

del pidfile

3444

2807

del pidfilename

3445

3446

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

3447

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3448

lambda: main_loop.quit() and False)

3449

2808

2809

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

2810

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

2811

3450

2812

if use_dbus:

3451

2813

3452

2814

@alternate_dbus_interfaces(

3453

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

3454

class MandosDBusService(DBusObjectWithObjectManager):

2815

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

2816

class MandosDBusService(DBusObjectWithAnnotations):

3455

2817

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

3456

2818

3457

2819

def __init__(self):

3458

2820

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

3459

2821

3460

2822

_interface = "se.recompile.Mandos"

3461

2823

3462

2824

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

3463

2825

def ClientAdded(self, objpath):

3464

2826

"D-Bus signal"

3465

2827

pass

3466

2828

3467

2829

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

3468

def ClientNotFound(self, key_id, address):

2830

def ClientNotFound(self, fingerprint, address):

3469

2831

"D-Bus signal"

3470

2832

pass

3471

3472

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

3473

"true"})

2833

3474

2834

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

3475

2835

def ClientRemoved(self, objpath, name):

3476

2836

"D-Bus signal"

3477

2837

pass

3478

3479

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

3480

"true"})

2838

3481

2839

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

3482

2840

def GetAllClients(self):

3483

2841

"D-Bus method"

3484

2842

return dbus.Array(c.dbus_object_path for c in

3485

tcp_server.clients.values())

3486

3487

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

3488

"true"})

2843

tcp_server.clients.itervalues())

2844

3489

2845

@dbus.service.method(_interface,

3490

2846

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

3491

2847

def GetAllClientsWithProperties(self):

3492

2848

"D-Bus method"

3493

2849

return dbus.Dictionary(

3494

{c.dbus_object_path: c.GetAll(

3495

"se.recompile.Mandos.Client")

3496

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

2850

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

2851

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

3497

2852

signature="oa{sv}")

3498

2853

3499

2854

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

3500

2855

def RemoveClient(self, object_path):

3501

2856

"D-Bus method"

3502

for c in tcp_server.clients.values():

2857

for c in tcp_server.clients.itervalues():

3503

2858

if c.dbus_object_path == object_path:

3504

2859

del tcp_server.clients[c.name]

3505

2860

c.remove_from_connection()

3506

# Don't signal the disabling

2861

# Don't signal anything except ClientRemoved

3507

2862

c.disable(quiet=True)

3508

# Emit D-Bus signal for removal

3509

self.client_removed_signal(c)

2863

# Emit D-Bus signal

2864

self.ClientRemoved(object_path, c.name)

3510

2865

return

3511

2866

raise KeyError(object_path)

3512

2867

3513

2868

del _interface

3514

3515

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3516

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

3517

def GetManagedObjects(self):

3518

"""D-Bus method"""

3519

return dbus.Dictionary(

3520

{client.dbus_object_path:

3521

dbus.Dictionary(

3522

{interface: client.GetAll(interface)

3523

for interface in

3524

client._get_all_interface_names()})

3525

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

3526

3527

def client_added_signal(self, client):

3528

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

3529

if use_dbus:

3530

# New standard signal

3531

self.InterfacesAdded(

3532

client.dbus_object_path,

3533

dbus.Dictionary(

3534

{interface: client.GetAll(interface)

3535

for interface in

3536

client._get_all_interface_names()}))

3537

# Old signal

3538

self.ClientAdded(client.dbus_object_path)

3539

3540

def client_removed_signal(self, client):

3541

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

3542

if use_dbus:

3543

# New standard signal

3544

self.InterfacesRemoved(

3545

client.dbus_object_path,

3546

client._get_all_interface_names())

3547

# Old signal

3548

self.ClientRemoved(client.dbus_object_path,

3549

client.name)

3550

2869

3551

2870

mandos_dbus_service = MandosDBusService()

3552

3553

# Save modules to variables to exempt the modules from being

3554

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

3555

mp = multiprocessing

3556

wn = wnull

3557

2871

3558

2872

def cleanup():

3559

2873

"Cleanup function; run on exit"

3560

2874

if zeroconf:

3561

2875

service.cleanup()

3562

3563

mp.active_children()

3564

wn.close()

2876

2877

multiprocessing.active_children()

2878

wnull.close()

3565

2879

if not (tcp_server.clients or client_settings):

3566

2880

return

3567

2881

3568

2882

# Store client before exiting. Secrets are encrypted with key

3569

2883

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

3570

2884

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

3571

2885

clients = {}

3572

2886

with PGPEngine() as pgp:

3573

for client in tcp_server.clients.values():

2887

for client in tcp_server.clients.itervalues():

3574

2888

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

3575

2889

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

3576

2890

key)

3577

2891

client_dict = {}

3578

2892

3579

2893

# A list of attributes that can not be pickled

3580

2894

# + secret.

3581

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

3582

"checker", "server_settings"}

2895

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

2896

"checker", "server_settings" }

3583

2897

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

3584

2898

.Object):

3585

2899

exclude.add(name)

3586

2900

3587

2901

client_dict["encrypted_secret"] = (client

3588

2902

.encrypted_secret)

3589

2903

for attr in client.client_structure:

3590

2904

if attr not in exclude:

3591

2905

client_dict[attr] = getattr(client, attr)

3592

2906

3593

2907

clients[client.name] = client_dict

3594

2908

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

3595

2909

3596

2910

try:

3597

2911

with tempfile.NamedTemporaryFile(

3598

mode="wb",

2912

mode='wb',

3599

2913

suffix=".pickle",

3600

prefix="clients-",

2914

prefix='clients-',

3601

2915

dir=os.path.dirname(stored_state_path),

3602

2916

delete=False) as stored_state:

3603

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

3604

protocol=2)

2917

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

3605

2918

tempname = stored_state.name

3606

2919

os.rename(tempname, stored_state_path)

3607

2920

except (IOError, OSError) as e:

3611

2924

except NameError:

3612

2925

pass

3613

2926

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

3614

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

3615

os.strerror(e.errno))

2927

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

2928

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

3616

2929

else:

3617

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

3618

exc_info=e)

2930

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

2931

exc_info=e)

3619

2932

raise

3620

2933

3621

2934

# Delete all clients, and settings from config

3622

2935

while tcp_server.clients:

3623

2936

name, client = tcp_server.clients.popitem()

3624

2937

if use_dbus:

3625

2938

client.remove_from_connection()

3626

# Don't signal the disabling

2939

# Don't signal anything except ClientRemoved

3627

2940

client.disable(quiet=True)

3628

# Emit D-Bus signal for removal

3629

2941

if use_dbus:

3630

mandos_dbus_service.client_removed_signal(client)

2942

# Emit D-Bus signal

2943

mandos_dbus_service.ClientRemoved(

2944

client.dbus_object_path, client.name)

3631

2945

client_settings.clear()

3632

2946

3633

2947

atexit.register(cleanup)

3634

3635

for client in tcp_server.clients.values():

2948

2949

for client in tcp_server.clients.itervalues():

3636

2950

if use_dbus:

3637

# Emit D-Bus signal for adding

3638

mandos_dbus_service.client_added_signal(client)

2951

# Emit D-Bus signal

2952

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3639

2953

# Need to initiate checking of clients

3640

2954

if client.enabled:

3641

client.init_checker(randomize_start=True)

3642

2955

client.init_checker()

2956

3643

2957

tcp_server.enable()

3644

2958

tcp_server.server_activate()

3645

2959

3646

2960

# Find out what port we got

3647

2961

if zeroconf:

3648

2962

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

3649

2963

if use_ipv6:

3650

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

3651

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

2964

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

2965

" flowinfo %d, scope_id %d",

2966

*tcp_server.socket.getsockname())

3652

2967

else: # IPv4

3653

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

3654

*tcp_server.socket.getsockname())

3655

3656

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

3657

2968

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

2969

*tcp_server.socket.getsockname())

2970

2971

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

2972

3658

2973

try:

3659

2974

if zeroconf:

3660

2975

# From the Avahi example code

3661

2976

try:

3662

2977

service.activate()

3663

2978

except dbus.exceptions.DBusException as error:

3664

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

2979

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

3665

2980

cleanup()

3666

2981

sys.exit(1)

3667

2982

# End of Avahi example code

3668

3669

GLib.io_add_watch(

3670

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

3671

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3672

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

3673

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

3674

3675

log.debug("Starting main loop")

2983

2984

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

2985

lambda *args, **kwargs:

2986

(tcp_server.handle_request

2987

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

2988

2989

logger.debug("Starting main loop")

3676

2990

main_loop.run()

3677

2991

except AvahiError as error:

3678

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

2992

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

3679

2993

cleanup()

3680

2994

sys.exit(1)

3681

2995

except KeyboardInterrupt:

3682

2996

if debug:

3683

2997

print("", file=sys.stderr)

3684

log.debug("Server received KeyboardInterrupt")

3685

log.debug("Server exiting")

2998

logger.debug("Server received KeyboardInterrupt")

2999

logger.debug("Server exiting")

3686

3000

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

3687

3001

cleanup()

3688

3002

3689

3690

def parse_test_args():

3691

# type: () -> argparse.Namespace

3692

parser = argparse.ArgumentParser(add_help=False)

3693

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

3694

parser.add_argument("--prefix", )

3695

args, unknown_args = parser.parse_known_args()

3696

if args.check:

3697

# Remove test options from sys.argv

3698

sys.argv[1:] = unknown_args

3699

return args

3700

3701

# Add all tests from doctest strings

3702

def load_tests(loader, tests, none):

3703

import doctest

3704

tests.addTests(doctest.DocTestSuite())

3705

return tests

3706

3707

if __name__ == "__main__":

3708

options = parse_test_args()

3709

try:

3710

if options.check:

3711

extra_test_prefix = options.prefix

3712

if extra_test_prefix is not None:

3713

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

3714

.result.wasSuccessful()):

3715

sys.exit(1)

3716

class ExtraTestLoader(unittest.TestLoader):

3717

testMethodPrefix = extra_test_prefix

3718

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

3719

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

3720

else:

3721

unittest.main(argv=[""])

3722

else:

3723

main()

3724

finally:

3725

logging.shutdown()

3726

3727

# Local Variables:

3728

# run-tests:

3729

# (lambda (&optional extra)

3730

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

3731

# extra))

3732

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

3733

# (funcall remove-test-window)

3734

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

3735

# run-tests-in-test-buffer:

3736

# (lambda (dir &optional extra)

3737

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

3738

# (setq buffer-read-only nil

3739

# default-directory dir)

3740

# (erase-buffer)

3741

# (compilation-mode))

3742

# (let ((process-result

3743

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

3744

# (process-file-shell-command

3745

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

3746

# (and (numberp process-result)

3747

# (= process-result 0))))

3748

# get-command-line:

3749

# (lambda (&optional extra)

3750

# (let ((quoted-script

3751

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

3752

# (format

3753

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

3754

# quoted-script)))

3755

# get-script-name:

3756

# (lambda ()

3757

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

3758

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

3759

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

3760

# (buffer-file-name))))

3761

# remove-test-window:

3762

# (lambda ()

3763

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

3764

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

3765

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

3766

# (lambda ()

3767

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

3768

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

3769

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

3770

# (display-buffer-overriding-action

3771

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

3772

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

3773

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

3774

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

3775

# eval:

3776

# (progn

3777

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

3778

# (funcall run-tests t)))

3779

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

3780

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

3781

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

3782

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

3783

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

3784

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

3785

# End:

3003

3004

if __name__ == '__main__':

3005

main()