/mandos/trunk : revision 749.1.2

1

#!/usr/bin/python3 -bI

2

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

3

#

1

#!/usr/bin/python2.7

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

33

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

37

from future_builtins import *

41

38

42

import sys

43

import unittest

44

import argparse

45

import logging

46

import os

47

39

try:

48

40

import SocketServer as socketserver

49

41

except ImportError:

50

42

import socketserver

51

43

import socket

44

import argparse

52

45

import datetime

53

46

import errno

47

import gnutls.crypto

48

import gnutls.connection

49

import gnutls.errors

50

import gnutls.library.functions

51

import gnutls.library.constants

52

import gnutls.library.types

54

53

try:

55

54

import ConfigParser as configparser

56

55

except ImportError:

57

56

import configparser

57

import sys

58

import re

59

import os

59

60

import signal

60

61

import subprocess

61

62

import atexit

62

63

import stat

64

import logging

63

65

import logging.handlers

64

66

import pwd

65

67

import contextlib

76

78

import tempfile

77

79

import itertools

78

80

import collections

79

import codecs

80

import random

81

import shlex

82

81

83

82

import dbus

84

83

import dbus.service

85

import gi

86

from gi.repository import GLib

84

try:

85

import gobject

86

except ImportError:

87

from gi.repository import GObject as gobject

88

import avahi

87

89

from dbus.mainloop.glib import DBusGMainLoop

88

90

import ctypes

89

91

import ctypes.util

90

92

import xml.dom.minidom

91

93

import inspect

92

94

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

input = raw_input

97

98

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

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Show warnings by default

114

if not sys.warnoptions:

115

import warnings

116

warnings.simplefilter("default")

117

118

# Try to find the value of SO_BINDTODEVICE:

119

try:

120

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

121

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

95

try:

122

96

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

123

97

except AttributeError:

124

98

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

127

99

from IN import SO_BINDTODEVICE

128

100

except ImportError:

129

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

130

# Try running the C preprocessor:

131

try:

132

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

133

"/dev/stdin"],

134

stdin=subprocess.PIPE,

135

stdout=subprocess.PIPE)

136

stdout = cc.communicate(

137

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

138

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

139

except (OSError, ValueError, IndexError):

140

# No value found

141

SO_BINDTODEVICE = None

142

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

145

146

version = "1.8.16"

101

SO_BINDTODEVICE = None

102

103

if sys.version_info.major == 2:

104

str = unicode

105

106

version = "1.6.9"

147

107

stored_state_file = "clients.pickle"

148

108

149

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

150

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

109

logger = logging.getLogger()

151

110

syslogger = None

152

111

153

112

try:

154

113

if_nametoindex = ctypes.cdll.LoadLibrary(

155

114

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

156

115

except (OSError, AttributeError):

157

116

158

117

def if_nametoindex(interface):

159

118

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

160

119

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

165

124

return interface_index

166

125

167

126

168

def copy_function(func):

169

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

170

if sys.version_info.major == 2:

171

return types.FunctionType(func.func_code,

172

func.func_globals,

173

func.func_name,

174

func.func_defaults,

175

func.func_closure)

176

else:

177

return types.FunctionType(func.__code__,

178

func.__globals__,

179

func.__name__,

180

func.__defaults__,

181

func.__closure__)

182

183

184

127

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

185

128

"""init logger and add loglevel"""

186

129

187

130

global syslogger

188

131

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

132

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

133

address = "/dev/log"))

191

134

syslogger.setFormatter(logging.Formatter

192

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

193

" %(message)s"))

194

log.addHandler(syslogger)

195

135

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

136

' %(message)s'))

137

logger.addHandler(syslogger)

138

196

139

if debug:

197

140

console = logging.StreamHandler()

198

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

199

" [%(process)d]:"

200

" %(levelname)s:"

201

" %(message)s"))

202

log.addHandler(console)

203

log.setLevel(level)

141

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

142

' [%(process)d]:'

143

' %(levelname)s:'

144

' %(message)s'))

145

logger.addHandler(console)

146

logger.setLevel(level)

204

147

205

148

206

149

class PGPError(Exception):

208

151

pass

209

152

210

153

211

class PGPEngine:

154

class PGPEngine(object):

212

155

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

213

156

214

157

def __init__(self):

215

158

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

216

self.gpg = "gpg"

217

try:

218

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

219

for line in output.splitlines():

220

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

221

if name == b"gpg":

222

self.gpg = path

223

break

224

except OSError as e:

225

if e.errno != errno.ENOENT:

226

raise

227

self.gnupgargs = ["--batch",

228

"--homedir", self.tempdir,

229

"--force-mdc",

230

"--quiet"]

231

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

232

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

233

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

234

159

self.gnupgargs = ['--batch',

160

'--home', self.tempdir,

161

'--force-mdc',

162

'--quiet',

163

'--no-use-agent']

164

235

165

def __enter__(self):

236

166

return self

237

167

238

168

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

239

169

self._cleanup()

240

170

return False

241

171

242

172

def __del__(self):

243

173

self._cleanup()

244

174

245

175

def _cleanup(self):

246

176

if self.tempdir is not None:

247

177

# Delete contents of tempdir

248

178

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

249

topdown=False):

179

topdown = False):

250

180

for filename in files:

251

181

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

252

182

for dirname in dirs:

254

184

# Remove tempdir

255

185

os.rmdir(self.tempdir)

256

186

self.tempdir = None

257

187

258

188

def password_encode(self, password):

259

189

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

260

190

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

265

195

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

266

196

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

267

197

return encoded

268

198

269

199

def encrypt(self, data, password):

270

200

passphrase = self.password_encode(password)

271

201

with tempfile.NamedTemporaryFile(

272

202

dir=self.tempdir) as passfile:

273

203

passfile.write(passphrase)

274

204

passfile.flush()

275

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

276

"--passphrase-file",

205

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

206

'--passphrase-file',

277

207

passfile.name]

278

208

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

209

stdin = subprocess.PIPE,

210

stdout = subprocess.PIPE,

211

stderr = subprocess.PIPE)

212

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

283

213

if proc.returncode != 0:

284

214

raise PGPError(err)

285

215

return ciphertext

286

216

287

217

def decrypt(self, data, password):

288

218

passphrase = self.password_encode(password)

289

219

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

220

dir = self.tempdir) as passfile:

291

221

passfile.write(passphrase)

292

222

passfile.flush()

293

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

294

"--passphrase-file",

223

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

224

'--passphrase-file',

295

225

passfile.name]

296

226

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

227

stdin = subprocess.PIPE,

228

stdout = subprocess.PIPE,

229

stderr = subprocess.PIPE)

230

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

301

231

if proc.returncode != 0:

302

232

raise PGPError(err)

303

233

return decrypted_plaintext

304

234

305

235

306

# Pretend that we have an Avahi module

307

class avahi:

308

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

309

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

310

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

311

PROTO_INET = 0 # avahi-common/address.h

312

PROTO_INET6 = 1 # avahi-common/address.h

313

DBUS_NAME = "org.freedesktop.Avahi"

314

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

315

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

316

DBUS_PATH_SERVER = "/"

317

318

@staticmethod

319

def string_array_to_txt_array(t):

320

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

321

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

322

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

323

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

324

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

325

SERVER_INVALID = 0 # avahi-common/defs.h

326

SERVER_REGISTERING = 1 # avahi-common/defs.h

327

SERVER_RUNNING = 2 # avahi-common/defs.h

328

SERVER_COLLISION = 3 # avahi-common/defs.h

329

SERVER_FAILURE = 4 # avahi-common/defs.h

330

331

332

236

class AvahiError(Exception):

333

237

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

334

238

self.value = value

344

248

pass

345

249

346

250

347

class AvahiService:

251

class AvahiService(object):

348

252

"""An Avahi (Zeroconf) service.

349

253

350

254

Attributes:

351

255

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

352

256

Used to optionally bind to the specified interface.

353

name: string; Example: "Mandos"

354

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

257

name: string; Example: 'Mandos'

258

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

355

259

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

356

260

port: integer; what port to announce

357

261

TXT: list of strings; TXT record for the service

364

268

server: D-Bus Server

365

269

bus: dbus.SystemBus()

366

270

"""

367

271

368

272

def __init__(self,

369

interface=avahi.IF_UNSPEC,

370

name=None,

371

servicetype=None,

372

port=None,

373

TXT=None,

374

domain="",

375

host="",

376

max_renames=32768,

377

protocol=avahi.PROTO_UNSPEC,

378

bus=None):

273

interface = avahi.IF_UNSPEC,

274

name = None,

275

servicetype = None,

276

port = None,

277

TXT = None,

278

domain = "",

279

host = "",

280

max_renames = 32768,

281

protocol = avahi.PROTO_UNSPEC,

282

bus = None):

379

283

self.interface = interface

380

284

self.name = name

381

285

self.type = servicetype

390

294

self.server = None

391

295

self.bus = bus

392

296

self.entry_group_state_changed_match = None

393

297

394

298

def rename(self, remove=True):

395

299

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

396

300

if self.rename_count >= self.max_renames:

397

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

398

" after %i retries, exiting.",

399

self.rename_count)

301

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

302

" after %i retries, exiting.",

303

self.rename_count)

400

304

raise AvahiServiceError("Too many renames")

401

305

self.name = str(

402

306

self.server.GetAlternativeServiceName(self.name))

403

307

self.rename_count += 1

404

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

405

self.name)

308

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

309

self.name)

406

310

if remove:

407

311

self.remove()

408

312

try:

410

314

except dbus.exceptions.DBusException as error:

411

315

if (error.get_dbus_name()

412

316

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

413

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

317

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

414

318

return self.rename(remove=False)

415

319

else:

416

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

320

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

417

321

self.cleanup()

418

322

os._exit(1)

419

323

420

324

def remove(self):

421

325

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

422

326

if self.entry_group_state_changed_match is not None:

424

328

self.entry_group_state_changed_match = None

425

329

if self.group is not None:

426

330

self.group.Reset()

427

331

428

332

def add(self):

429

333

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

430

334

self.remove()

435

339

avahi.DBUS_INTERFACE_ENTRY_GROUP)

436

340

self.entry_group_state_changed_match = (

437

341

self.group.connect_to_signal(

438

"StateChanged", self.entry_group_state_changed))

439

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

440

self.name, self.type)

342

'StateChanged', self.entry_group_state_changed))

343

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

344

self.name, self.type)

441

345

self.group.AddService(

442

346

self.interface,

443

347

self.protocol,

447

351

dbus.UInt16(self.port),

448

352

avahi.string_array_to_txt_array(self.TXT))

449

353

self.group.Commit()

450

354

451

355

def entry_group_state_changed(self, state, error):

452

356

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

453

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

454

357

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

358

455

359

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

log.debug("Zeroconf service established.")

360

logger.debug("Zeroconf service established.")

457

361

elif state == avahi.ENTRY_GROUP_COLLISION:

458

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

362

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

459

363

self.rename()

460

364

elif state == avahi.ENTRY_GROUP_FAILURE:

461

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

462

str(error))

365

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

366

str(error))

463

367

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

464

368

465

369

def cleanup(self):

466

370

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

467

371

if self.group is not None:

472

376

pass

473

377

self.group = None

474

378

self.remove()

475

379

476

380

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

477

381

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

478

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

382

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

479

383

bad_states = {

480

384

avahi.SERVER_INVALID: "Zeroconf server invalid",

481

385

avahi.SERVER_REGISTERING: None,

485

389

if state in bad_states:

486

390

if bad_states[state] is not None:

487

391

if error is None:

488

log.error(bad_states[state])

392

logger.error(bad_states[state])

489

393

else:

490

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

394

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

491

395

self.cleanup()

492

396

elif state == avahi.SERVER_RUNNING:

493

try:

494

self.add()

495

except dbus.exceptions.DBusException as error:

496

if (error.get_dbus_name()

497

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

498

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

499

return self.rename(remove=False)

500

else:

501

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

502

self.cleanup()

503

os._exit(1)

397

self.add()

504

398

else:

505

399

if error is None:

506

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

400

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

507

401

else:

508

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

509

402

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

403

510

404

def activate(self):

511

405

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

512

406

if self.server is None:

523

417

class AvahiServiceToSyslog(AvahiService):

524

418

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

525

419

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

526

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

527

**kwargs)

420

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

528

421

syslogger.setFormatter(logging.Formatter(

529

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

422

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

530

423

.format(self.name)))

531

424

return ret

532

425

533

534

# Pretend that we have a GnuTLS module

535

class gnutls:

536

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

537

538

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

539

if library is None:

540

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

541

_library = ctypes.cdll.LoadLibrary(library)

542

del library

543

544

# Unless otherwise indicated, the constants and types below are

545

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

546

547

# Constants

548

E_SUCCESS = 0

549

E_INTERRUPTED = -52

550

E_AGAIN = -28

551

CRT_OPENPGP = 2

552

CRT_RAWPK = 3

553

CLIENT = 2

554

SHUT_RDWR = 0

555

CRD_CERTIFICATE = 1

556

E_NO_CERTIFICATE_FOUND = -49

557

X509_FMT_DER = 0

558

NO_TICKETS = 1<<10

559

ENABLE_RAWPK = 1<<18

560

CTYPE_PEERS = 3

561

KEYID_USE_SHA256 = 1 # gnutls/x509.h

562

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

563

564

# Types

565

class _session_int(ctypes.Structure):

566

_fields_ = []

567

session_t = ctypes.POINTER(_session_int)

568

569

class certificate_credentials_st(ctypes.Structure):

570

_fields_ = []

571

certificate_credentials_t = ctypes.POINTER(

572

certificate_credentials_st)

573

certificate_type_t = ctypes.c_int

574

575

class datum_t(ctypes.Structure):

576

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

577

("size", ctypes.c_uint)]

578

579

class _openpgp_crt_int(ctypes.Structure):

580

_fields_ = []

581

openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)

582

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

583

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

584

credentials_type_t = ctypes.c_int

585

transport_ptr_t = ctypes.c_void_p

586

close_request_t = ctypes.c_int

587

588

# Exceptions

589

class Error(Exception):

590

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

591

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

592

# code is passed, convert it to a string with

593

# gnutls.strerror()

594

self.code = code

595

if message is None and code is not None:

596

message = gnutls.strerror(code).decode(

597

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

598

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

599

message, *args)

600

601

class CertificateSecurityError(Error):

602

pass

603

604

class PointerTo:

605

def __init__(self, cls):

606

self.cls = cls

607

608

def from_param(self, obj):

609

if not isinstance(obj, self.cls):

610

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

611

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

612

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

613

614

class CastToVoidPointer:

615

def __init__(self, cls):

616

self.cls = cls

617

618

def from_param(self, obj):

619

if not isinstance(obj, self.cls):

620

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

621

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

622

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

623

624

class With_from_param:

625

@classmethod

626

def from_param(cls, obj):

627

return obj._as_parameter_

628

629

# Classes

630

class Credentials(With_from_param):

631

def __init__(self):

632

self._as_parameter_ = gnutls.certificate_credentials_t()

633

gnutls.certificate_allocate_credentials(self)

634

self.type = gnutls.CRD_CERTIFICATE

635

636

def __del__(self):

637

gnutls.certificate_free_credentials(self)

638

639

class ClientSession(With_from_param):

640

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

641

self._as_parameter_ = gnutls.session_t()

642

gnutls_flags = gnutls.CLIENT

643

if gnutls.check_version(b"3.5.6"):

644

gnutls_flags |= gnutls.NO_TICKETS

645

if gnutls.has_rawpk:

646

gnutls_flags |= gnutls.ENABLE_RAWPK

647

gnutls.init(self, gnutls_flags)

648

del gnutls_flags

649

gnutls.set_default_priority(self)

650

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

651

gnutls.handshake_set_private_extensions(self, True)

652

self.socket = socket

653

if credentials is None:

654

credentials = gnutls.Credentials()

655

gnutls.credentials_set(self, credentials.type,

656

credentials)

657

self.credentials = credentials

658

659

def __del__(self):

660

gnutls.deinit(self)

661

662

def handshake(self):

663

return gnutls.handshake(self)

664

665

def send(self, data):

666

data = bytes(data)

667

data_len = len(data)

668

while data_len > 0:

669

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

670

data_len)

671

672

def bye(self):

673

return gnutls.bye(self, gnutls.SHUT_RDWR)

674

675

# Error handling functions

676

def _error_code(result):

677

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

678

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

679

if result >= gnutls.E_SUCCESS:

680

return result

681

if result == gnutls.E_NO_CERTIFICATE_FOUND:

682

raise gnutls.CertificateSecurityError(code=result)

683

raise gnutls.Error(code=result)

684

685

def _retry_on_error(result, func, arguments,

686

_error_code=_error_code):

687

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

688

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

689

while result < gnutls.E_SUCCESS:

690

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

691

return _error_code(result)

692

result = func(*arguments)

693

return result

694

695

# Unless otherwise indicated, the function declarations below are

696

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

697

698

# Functions

699

priority_set_direct = _library.gnutls_priority_set_direct

700

priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,

701

ctypes.POINTER(ctypes.c_char_p)]

702

priority_set_direct.restype = _error_code

703

704

init = _library.gnutls_init

705

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

706

init.restype = _error_code

707

708

set_default_priority = _library.gnutls_set_default_priority

709

set_default_priority.argtypes = [ClientSession]

710

set_default_priority.restype = _error_code

711

712

record_send = _library.gnutls_record_send

713

record_send.argtypes = [ClientSession, ctypes.c_void_p,

714

ctypes.c_size_t]

715

record_send.restype = ctypes.c_ssize_t

716

record_send.errcheck = _retry_on_error

717

718

certificate_allocate_credentials = (

719

_library.gnutls_certificate_allocate_credentials)

720

certificate_allocate_credentials.argtypes = [

721

PointerTo(Credentials)]

722

certificate_allocate_credentials.restype = _error_code

723

724

certificate_free_credentials = (

725

_library.gnutls_certificate_free_credentials)

726

certificate_free_credentials.argtypes = [Credentials]

727

certificate_free_credentials.restype = None

728

729

handshake_set_private_extensions = (

730

_library.gnutls_handshake_set_private_extensions)

731

handshake_set_private_extensions.argtypes = [ClientSession,

732

ctypes.c_int]

733

handshake_set_private_extensions.restype = None

734

735

credentials_set = _library.gnutls_credentials_set

736

credentials_set.argtypes = [ClientSession, credentials_type_t,

737

CastToVoidPointer(Credentials)]

738

credentials_set.restype = _error_code

739

740

strerror = _library.gnutls_strerror

741

strerror.argtypes = [ctypes.c_int]

742

strerror.restype = ctypes.c_char_p

743

744

certificate_type_get = _library.gnutls_certificate_type_get

745

certificate_type_get.argtypes = [ClientSession]

746

certificate_type_get.restype = _error_code

747

748

certificate_get_peers = _library.gnutls_certificate_get_peers

749

certificate_get_peers.argtypes = [ClientSession,

750

ctypes.POINTER(ctypes.c_uint)]

751

certificate_get_peers.restype = ctypes.POINTER(datum_t)

752

753

global_set_log_level = _library.gnutls_global_set_log_level

754

global_set_log_level.argtypes = [ctypes.c_int]

755

global_set_log_level.restype = None

756

757

global_set_log_function = _library.gnutls_global_set_log_function

758

global_set_log_function.argtypes = [log_func]

759

global_set_log_function.restype = None

760

761

deinit = _library.gnutls_deinit

762

deinit.argtypes = [ClientSession]

763

deinit.restype = None

764

765

handshake = _library.gnutls_handshake

766

handshake.argtypes = [ClientSession]

767

handshake.restype = ctypes.c_int

768

handshake.errcheck = _retry_on_error

769

770

transport_set_ptr = _library.gnutls_transport_set_ptr

771

transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]

772

transport_set_ptr.restype = None

773

774

bye = _library.gnutls_bye

775

bye.argtypes = [ClientSession, close_request_t]

776

bye.restype = ctypes.c_int

777

bye.errcheck = _retry_on_error

778

779

check_version = _library.gnutls_check_version

780

check_version.argtypes = [ctypes.c_char_p]

781

check_version.restype = ctypes.c_char_p

782

783

_need_version = b"3.3.0"

784

if check_version(_need_version) is None:

785

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

786

.format(_need_version))

787

788

_tls_rawpk_version = b"3.6.6"

789

has_rawpk = bool(check_version(_tls_rawpk_version))

790

791

if has_rawpk:

792

# Types

793

class pubkey_st(ctypes.Structure):

794

_fields = []

795

pubkey_t = ctypes.POINTER(pubkey_st)

796

797

x509_crt_fmt_t = ctypes.c_int

798

799

# All the function declarations below are from

800

# gnutls/abstract.h

801

pubkey_init = _library.gnutls_pubkey_init

802

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

803

pubkey_init.restype = _error_code

804

805

pubkey_import = _library.gnutls_pubkey_import

806

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

807

x509_crt_fmt_t]

808

pubkey_import.restype = _error_code

809

810

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

811

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

812

ctypes.POINTER(ctypes.c_ubyte),

813

ctypes.POINTER(ctypes.c_size_t)]

814

pubkey_get_key_id.restype = _error_code

815

816

pubkey_deinit = _library.gnutls_pubkey_deinit

817

pubkey_deinit.argtypes = [pubkey_t]

818

pubkey_deinit.restype = None

819

else:

820

# All the function declarations below are from

821

# gnutls/openpgp.h

822

823

openpgp_crt_init = _library.gnutls_openpgp_crt_init

824

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

825

openpgp_crt_init.restype = _error_code

826

827

openpgp_crt_import = _library.gnutls_openpgp_crt_import

828

openpgp_crt_import.argtypes = [openpgp_crt_t,

829

ctypes.POINTER(datum_t),

830

openpgp_crt_fmt_t]

831

openpgp_crt_import.restype = _error_code

832

833

openpgp_crt_verify_self = \

834

_library.gnutls_openpgp_crt_verify_self

835

openpgp_crt_verify_self.argtypes = [

836

openpgp_crt_t,

837

ctypes.c_uint,

838

ctypes.POINTER(ctypes.c_uint),

839

]

840

openpgp_crt_verify_self.restype = _error_code

841

842

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

843

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

844

openpgp_crt_deinit.restype = None

845

846

openpgp_crt_get_fingerprint = (

847

_library.gnutls_openpgp_crt_get_fingerprint)

848

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

849

ctypes.c_void_p,

850

ctypes.POINTER(

851

ctypes.c_size_t)]

852

openpgp_crt_get_fingerprint.restype = _error_code

853

854

if check_version(b"3.6.4"):

855

certificate_type_get2 = _library.gnutls_certificate_type_get2

856

certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]

857

certificate_type_get2.restype = _error_code

858

859

# Remove non-public functions

860

del _error_code, _retry_on_error

861

862

863

426

def call_pipe(connection, # : multiprocessing.Connection

864

427

func, *args, **kwargs):

865

428

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

866

429

867

430

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

868

431

return value on the provided multiprocessing.Connection.

869

432

"""

870

433

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

871

434

connection.close()

872

435

873

874

class Client:

436

class Client(object):

875

437

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

876

438

877

439

Attributes:

878

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

440

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

879

441

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

880

442

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

881

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

882

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

883

running.

884

checker_callback_tag: a GLib event source tag, or None

443

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

444

to see if the client lives.

445

'None' if no process is running.

446

checker_callback_tag: a gobject event source tag, or None

885

447

checker_command: string; External command which is run to check

886

448

if client lives. %() expansions are done at

887

449

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

888

450

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

889

checker_initiator_tag: a GLib event source tag, or None

451

checker_initiator_tag: a gobject event source tag, or None

890

452

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

891

453

client_structure: Object describing what attributes a client has

892

454

and is used for storing the client at exit

893

455

current_checker_command: string; current running checker_command

894

disable_initiator_tag: a GLib event source tag, or None

456

disable_initiator_tag: a gobject event source tag, or None

895

457

enabled: bool()

896

458

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

897

uniquely identify an OpenPGP client

898

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

899

a client using raw public keys

459

uniquely identify the client

900

460

host: string; available for use by the checker command

901

461

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

902

462

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

918

478

disabled, or None

919

479

server_settings: The server_settings dict from main()

920

480

"""

921

481

922

482

runtime_expansions = ("approval_delay", "approval_duration",

923

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

483

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

924

484

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

925

485

"last_approval_request", "last_checked_ok",

926

486

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

935

495

"approved_by_default": "True",

936

496

"enabled": "True",

937

497

}

938

498

939

499

@staticmethod

940

500

def config_parser(config):

941

501

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

948

508

for client_name in config.sections():

949

509

section = dict(config.items(client_name))

950

510

client = settings[client_name] = {}

951

511

952

512

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

953

513

# Reformat values from string types to Python types

954

514

client["approved_by_default"] = config.getboolean(

955

515

client_name, "approved_by_default")

956

516

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

957

517

"enabled")

958

959

# Uppercase and remove spaces from key_id and fingerprint

960

# for later comparison purposes with return value from the

961

# key_id() and fingerprint() functions

962

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

963

.replace(" ", ""))

518

519

# Uppercase and remove spaces from fingerprint for later

520

# comparison purposes with return value from the

521

# fingerprint() function

964

522

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

965

523

.replace(" ", ""))

966

524

if "secret" in section:

967

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

968

.encode("utf-8"),

969

"base64")

525

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

970

526

elif "secfile" in section:

971

527

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

972

528

(section["secfile"])),

987

543

client["last_approval_request"] = None

988

544

client["last_checked_ok"] = None

989

545

client["last_checker_status"] = -2

990

546

991

547

return settings

992

993

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

548

549

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

994

550

self.name = name

995

551

if server_settings is None:

996

552

server_settings = {}

998

554

# adding all client settings

999

555

for setting, value in settings.items():

1000

556

setattr(self, setting, value)

1001

557

1002

558

if self.enabled:

1003

559

if not hasattr(self, "last_enabled"):

1004

560

self.last_enabled = datetime.datetime.utcnow()

1008

564

else:

1009

565

self.last_enabled = None

1010

566

self.expires = None

1011

1012

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

1013

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

1014

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

567

568

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

569

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

1015

570

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

1016

571

datetime.datetime.utcnow())

1017

572

1018

573

# attributes specific for this server instance

1019

574

self.checker = None

1020

575

self.checker_initiator_tag = None

1026

581

self.changedstate = multiprocessing_manager.Condition(

1027

582

multiprocessing_manager.Lock())

1028

583

self.client_structure = [attr

1029

for attr in self.__dict__.keys()

584

for attr in self.__dict__.iterkeys()

1030

585

if not attr.startswith("_")]

1031

586

self.client_structure.append("client_structure")

1032

587

1033

588

for name, t in inspect.getmembers(

1034

589

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

1035

590

if not name.startswith("_"):

1036

591

self.client_structure.append(name)

1037

592

1038

593

# Send notice to process children that client state has changed

1039

594

def send_changedstate(self):

1040

595

with self.changedstate:

1041

596

self.changedstate.notify_all()

1042

597

1043

598

def enable(self):

1044

599

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

1045

600

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

1046

601

# Already enabled

1047

602

return

603

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

1048

604

self.enabled = True

1049

605

self.last_enabled = datetime.datetime.utcnow()

1050

606

self.init_checker()

1051

607

self.send_changedstate()

1052

608

1053

609

def disable(self, quiet=True):

1054

610

"""Disable this client."""

1055

611

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

1056

612

return False

1057

613

if not quiet:

1058

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

614

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

1059

615

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

1060

GLib.source_remove(self.disable_initiator_tag)

616

gobject.source_remove(self.disable_initiator_tag)

1061

617

self.disable_initiator_tag = None

1062

618

self.expires = None

1063

619

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

1064

GLib.source_remove(self.checker_initiator_tag)

620

gobject.source_remove(self.checker_initiator_tag)

1065

621

self.checker_initiator_tag = None

1066

622

self.stop_checker()

1067

623

self.enabled = False

1068

624

if not quiet:

1069

625

self.send_changedstate()

1070

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

626

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

1071

627

return False

1072

628

1073

629

def __del__(self):

1074

630

self.disable()

1075

1076

def init_checker(self, randomize_start=False):

1077

# Schedule a new checker to be started a randomly selected

1078

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

1079

# the startup of checkers over time when the server is

1080

# started.

631

632

def init_checker(self):

633

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

634

# and every interval from then on.

1081

635

if self.checker_initiator_tag is not None:

1082

GLib.source_remove(self.checker_initiator_tag)

1083

interval_milliseconds = int(self.interval.total_seconds()

1084

* 1000)

1085

if randomize_start:

1086

delay_milliseconds = random.randrange(

1087

interval_milliseconds + 1)

1088

else:

1089

delay_milliseconds = interval_milliseconds

1090

self.checker_initiator_tag = GLib.timeout_add(

1091

delay_milliseconds, self.start_checker, randomize_start)

1092

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

1093

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

1094

# expire at the soonest one interval after a checker was

1095

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

1096

# time might have to be extended.

1097

now = datetime.datetime.utcnow()

1098

self.expires = now + delay + self.interval

1099

# Schedule a disable() at expire time

636

gobject.source_remove(self.checker_initiator_tag)

637

self.checker_initiator_tag = gobject.timeout_add(

638

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

639

self.start_checker)

640

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

1100

641

if self.disable_initiator_tag is not None:

1101

GLib.source_remove(self.disable_initiator_tag)

1102

self.disable_initiator_tag = GLib.timeout_add(

1103

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

1104

self.disable)

1105

1106

def checker_callback(self, source, condition, connection,

1107

command):

642

gobject.source_remove(self.disable_initiator_tag)

643

self.disable_initiator_tag = gobject.timeout_add(

644

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

645

# Also start a new checker *right now*.

646

self.start_checker()

647

648

def checker_callback(self, source, condition,

649

(connection, command)):

1108

650

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

651

self.checker_callback_tag = None

652

self.checker = None

1109

653

# Read return code from connection (see call_pipe)

1110

654

returncode = connection.recv()

1111

655

connection.close()

1112

if self.checker is not None:

1113

self.checker.join()

1114

self.checker_callback_tag = None

1115

self.checker = None

1116

656

1117

657

if returncode >= 0:

1118

658

self.last_checker_status = returncode

1119

659

self.last_checker_signal = None

1120

660

if self.last_checker_status == 0:

1121

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

661

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

662

vars(self))

1122

663

self.checked_ok()

1123

664

else:

1124

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

665

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

1125

666

else:

1126

667

self.last_checker_status = -1

1127

668

self.last_checker_signal = -returncode

1128

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

669

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

670

vars(self))

1129

671

return False

1130

672

1131

673

def checked_ok(self):

1132

674

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

1133

675

self.last_checked_ok = datetime.datetime.utcnow()

1134

676

self.last_checker_status = 0

1135

677

self.last_checker_signal = None

1136

678

self.bump_timeout()

1137

679

1138

680

def bump_timeout(self, timeout=None):

1139

681

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

1140

682

if timeout is None:

1141

683

timeout = self.timeout

1142

684

if self.disable_initiator_tag is not None:

1143

GLib.source_remove(self.disable_initiator_tag)

685

gobject.source_remove(self.disable_initiator_tag)

1144

686

self.disable_initiator_tag = None

1145

687

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

1146

self.disable_initiator_tag = GLib.timeout_add(

688

self.disable_initiator_tag = gobject.timeout_add(

1147

689

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

1148

690

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

1149

691

1150

692

def need_approval(self):

1151

693

self.last_approval_request = datetime.datetime.utcnow()

1152

1153

def start_checker(self, start_was_randomized=False):

694

695

def start_checker(self):

1154

696

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

1155

697

1156

698

If a checker already exists, leave it running and do

1157

699

nothing."""

1158

700

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

1163

705

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

1164

706

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

1165

707

# should be.

1166

708

1167

709

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

1168

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

710

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

1169

711

self.checker.join()

1170

712

self.checker = None

1171

713

# Start a new checker if needed

1172

714

if self.checker is None:

1173

715

# Escape attributes for the shell

1174

716

escaped_attrs = {

1175

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

1176

for attr in self.runtime_expansions}

717

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

718

for attr in self.runtime_expansions }

1177

719

try:

1178

720

command = self.checker_command % escaped_attrs

1179

721

except TypeError as error:

1180

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

1181

self.checker_command, exc_info=error)

722

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

723

self.checker_command,

724

exc_info=error)

1182

725

return True # Try again later

1183

726

self.current_checker_command = command

1184

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

727

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

728

self.name)

1185

729

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

1186

730

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

1187

731

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

1189

733

# The exception is when not debugging but nevertheless

1190

734

# running in the foreground; use the previously

1191

735

# created wnull.

1192

popen_args = {"close_fds": True,

1193

"shell": True,

1194

"cwd": "/"}

736

popen_args = { "close_fds": True,

737

"shell": True,

738

"cwd": "/" }

1195

739

if (not self.server_settings["debug"]

1196

740

and self.server_settings["foreground"]):

1197

741

popen_args.update({"stdout": wnull,

1198

"stderr": wnull})

742

"stderr": wnull })

1199

743

pipe = multiprocessing.Pipe(duplex=False)

1200

744

self.checker = multiprocessing.Process(

1201

target=call_pipe,

1202

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

1203

kwargs=popen_args)

745

target = call_pipe,

746

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

747

kwargs = popen_args)

1204

748

self.checker.start()

1205

self.checker_callback_tag = GLib.io_add_watch(

1206

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

1207

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1208

self.checker_callback, pipe[0], command)

1209

if start_was_randomized:

1210

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

1211

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

1212

# interval from then on.

1213

now = datetime.datetime.utcnow()

1214

self.checker_initiator_tag = GLib.timeout_add(

1215

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

1216

self.start_checker)

1217

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

1218

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

1219

return False

1220

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

749

self.checker_callback_tag = gobject.io_add_watch(

750

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

751

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

752

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

1221

753

return True

1222

754

1223

755

def stop_checker(self):

1224

756

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

1225

757

if self.checker_callback_tag:

1226

GLib.source_remove(self.checker_callback_tag)

758

gobject.source_remove(self.checker_callback_tag)

1227

759

self.checker_callback_tag = None

1228

760

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

1229

761

return

1230

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

762

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

1231

763

self.checker.terminate()

1232

764

self.checker = None

1233

765

1238

770

byte_arrays=False):

1239

771

"""Decorators for marking methods of a DBusObjectWithProperties to

1240

772

become properties on the D-Bus.

1241

773

1242

774

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

1243

775

and with one argument by "Set".

1244

776

1245

777

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

1246

778

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

1247

779

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

1251

783

if byte_arrays and signature != "ay":

1252

784

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

1253

785

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

1254

786

1255

787

def decorator(func):

1256

788

func._dbus_is_property = True

1257

789

func._dbus_interface = dbus_interface

1260

792

func._dbus_name = func.__name__

1261

793

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

1262

794

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

1263

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

795

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1264

796

return func

1265

797

1266

798

return decorator

1267

799

1268

800

1269

801

def dbus_interface_annotations(dbus_interface):

1270

802

"""Decorator for marking functions returning interface annotations

1271

803

1272

804

Usage:

1273

805

1274

806

@dbus_interface_annotations("org.example.Interface")

1275

807

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

1276

808

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

1277

809

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

1278

810

"false"}

1279

811

"""

1280

812

1281

813

def decorator(func):

1282

814

func._dbus_is_interface = True

1283

815

func._dbus_interface = dbus_interface

1284

816

func._dbus_name = dbus_interface

1285

817

return func

1286

818

1287

819

return decorator

1288

820

1289

821

1290

822

def dbus_annotations(annotations):

1291

823

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

1292

824

Usage:

1293

825

1294

826

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

1295

827

"org.freedesktop.DBus.Property."

1296

828

"EmitsChangedSignal": "false"})

1298

830

access="r")

1299

831

def Property_dbus_property(self):

1300

832

return dbus.Boolean(False)

1301

1302

See also the DBusObjectWithAnnotations class.

1303

833

"""

1304

834

1305

835

def decorator(func):

1306

836

func._dbus_annotations = annotations

1307

837

return func

1308

838

1309

839

return decorator

1310

840

1311

841

1327

857

pass

1328

858

1329

859

1330

class DBusObjectWithAnnotations(dbus.service.Object):

1331

"""A D-Bus object with annotations.

1332

1333

Classes inheriting from this can use the dbus_annotations

1334

decorator to add annotations to methods or signals.

860

class DBusObjectWithProperties(dbus.service.Object):

861

"""A D-Bus object with properties.

862

863

Classes inheriting from this can use the dbus_service_property

864

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

865

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

1335

866

"""

1336

867

1337

868

@staticmethod

1338

869

def _is_dbus_thing(thing):

1339

870

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

1340

871

1341

872

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

1342

873

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

1343

874

"""

1344

875

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

1345

876

False)

1346

877

1347

878

def _get_all_dbus_things(self, thing):

1348

879

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

1349

880

"""

1352

883

for cls in self.__class__.__mro__

1353

884

for name, athing in

1354

885

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

1355

1356

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1357

out_signature="s",

1358

path_keyword="object_path",

1359

connection_keyword="connection")

1360

def Introspect(self, object_path, connection):

1361

"""Overloading of standard D-Bus method.

1362

1363

Inserts annotation tags on methods and signals.

1364

"""

1365

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

1366

connection)

1367

try:

1368

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

1369

1370

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

1371

# Add annotation tags

1372

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

1373

for tag in if_tag.getElementsByTagName(typ):

1374

annots = dict()

1375

for name, prop in (self.

1376

_get_all_dbus_things(typ)):

1377

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

1378

and prop._dbus_interface

1379

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

1380

annots.update(getattr(

1381

prop, "_dbus_annotations", {}))

1382

for name, value in annots.items():

1383

ann_tag = document.createElement(

1384

"annotation")

1385

ann_tag.setAttribute("name", name)

1386

ann_tag.setAttribute("value", value)

1387

tag.appendChild(ann_tag)

1388

# Add interface annotation tags

1389

for annotation, value in dict(

1390

itertools.chain.from_iterable(

1391

annotations().items()

1392

for name, annotations

1393

in self._get_all_dbus_things("interface")

1394

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

1395

)).items():

1396

ann_tag = document.createElement("annotation")

1397

ann_tag.setAttribute("name", annotation)

1398

ann_tag.setAttribute("value", value)

1399

if_tag.appendChild(ann_tag)

1400

# Fix argument name for the Introspect method itself

1401

if (if_tag.getAttribute("name")

1402

== dbus.INTROSPECTABLE_IFACE):

1403

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

1404

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

1405

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

1406

if (arg.getAttribute("direction")

1407

== "out"):

1408

arg.setAttribute("name",

1409

"xml_data")

1410

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

1411

document.unlink()

1412

except (AttributeError, xml.dom.DOMException,

1413

xml.parsers.expat.ExpatError) as error:

1414

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

1415

exc_info=error)

1416

return xmlstring

1417

1418

1419

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1420

"""A D-Bus object with properties.

1421

1422

Classes inheriting from this can use the dbus_service_property

1423

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

1424

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

1425

"""

1426

886

1427

887

def _get_dbus_property(self, interface_name, property_name):

1428

888

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

1429

889

property with the specified name and interface.

1434

894

if (value._dbus_name == property_name

1435

895

and value._dbus_interface == interface_name):

1436

896

return value.__get__(self)

1437

897

1438

898

# No such property

1439

899

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

1440

900

self.dbus_object_path, interface_name, property_name))

1441

1442

@classmethod

1443

def _get_all_interface_names(cls):

1444

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

1445

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

1446

"_dbus_interface", None)

1447

for x in (inspect.getmro(cls))

1448

for attr in dir(x))

1449

if name is not None)

1450

901

1451

902

@dbus.service.method(dbus.PROPERTIES_IFACE,

1452

903

in_signature="ss",

1453

904

out_signature="v")

1461

912

if not hasattr(value, "variant_level"):

1462

913

return value

1463

914

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

1464

915

1465

916

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

1466

917

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

1467

918

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

1476

927

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

1477

928

"'ay' signature {!r}"

1478

929

.format(prop._dbus_signature))

1479

value = dbus.ByteArray(bytes(value))

930

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

931

for byte in value))

1480

932

prop(value)

1481

933

1482

934

@dbus.service.method(dbus.PROPERTIES_IFACE,

1483

935

in_signature="s",

1484

936

out_signature="a{sv}")

1485

937

def GetAll(self, interface_name):

1486

938

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

1487

939

standard.

1488

940

1489

941

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

1490

942

"""

1491

943

properties = {}

1502

954

properties[name] = value

1503

955

continue

1504

956

properties[name] = type(value)(

1505

value, variant_level=value.variant_level + 1)

957

value, variant_level = value.variant_level + 1)

1506

958

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

1507

959

1508

960

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

1509

961

def PropertiesChanged(self, interface_name, changed_properties,

1510

962

invalidated_properties):

1512

964

standard.

1513

965

"""

1514

966

pass

1515

967

1516

968

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1517

969

out_signature="s",

1518

path_keyword="object_path",

1519

connection_keyword="connection")

970

path_keyword='object_path',

971

connection_keyword='connection')

1520

972

def Introspect(self, object_path, connection):

1521

973

"""Overloading of standard D-Bus method.

1522

974

1523

975

Inserts property tags and interface annotation tags.

1524

976

"""

1525

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1526

object_path,

1527

connection)

977

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

978

connection)

1528

979

try:

1529

980

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

1530

981

1531

982

def make_tag(document, name, prop):

1532

983

e = document.createElement("property")

1533

984

e.setAttribute("name", name)

1534

985

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

1535

986

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

1536

987

return e

1537

988

1538

989

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

1539

990

# Add property tags

1540

991

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

1543

994

if prop._dbus_interface

1544

995

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

1545

996

if_tag.appendChild(tag)

1546

# Add annotation tags for properties

1547

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

1548

annots = dict()

1549

for name, prop in self._get_all_dbus_things(

1550

"property"):

1551

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

1552

and prop._dbus_interface

1553

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

1554

annots.update(getattr(

1555

prop, "_dbus_annotations", {}))

1556

for name, value in annots.items():

1557

ann_tag = document.createElement(

1558

"annotation")

1559

ann_tag.setAttribute("name", name)

1560

ann_tag.setAttribute("value", value)

1561

tag.appendChild(ann_tag)

997

# Add annotation tags

998

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

999

for tag in if_tag.getElementsByTagName(typ):

1000

annots = dict()

1001

for name, prop in (self.

1002

_get_all_dbus_things(typ)):

1003

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

1004

and prop._dbus_interface

1005

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

1006

annots.update(getattr(

1007

prop, "_dbus_annotations", {}))

1008

for name, value in annots.items():

1009

ann_tag = document.createElement(

1010

"annotation")

1011

ann_tag.setAttribute("name", name)

1012

ann_tag.setAttribute("value", value)

1013

tag.appendChild(ann_tag)

1014

# Add interface annotation tags

1015

for annotation, value in dict(

1016

itertools.chain.from_iterable(

1017

annotations().items()

1018

for name, annotations

1019

in self._get_all_dbus_things("interface")

1020

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

1021

)).items():

1022

ann_tag = document.createElement("annotation")

1023

ann_tag.setAttribute("name", annotation)

1024

ann_tag.setAttribute("value", value)

1025

if_tag.appendChild(ann_tag)

1562

1026

# Add the names to the return values for the

1563

1027

# "org.freedesktop.DBus.Properties" methods

1564

1028

if (if_tag.getAttribute("name")

1578

1042

document.unlink()

1579

1043

except (AttributeError, xml.dom.DOMException,

1580

1044

xml.parsers.expat.ExpatError) as error:

1581

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

1582

exc_info=error)

1583

return xmlstring

1584

1585

1586

try:

1587

dbus.OBJECT_MANAGER_IFACE

1588

except AttributeError:

1589

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

1590

1591

1592

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1593

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

1594

1595

Classes inheriting from this exposes the standard

1596

GetManagedObjects call and the InterfacesAdded and

1597

InterfacesRemoved signals on the standard

1598

"org.freedesktop.DBus.ObjectManager" interface.

1599

1600

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

1601

manually.

1602

"""

1603

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1604

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

1605

def GetManagedObjects(self):

1606

"""This function must be overridden"""

1607

raise NotImplementedError()

1608

1609

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1610

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

1611

def InterfacesAdded(self, object_path, interfaces_and_properties):

1612

pass

1613

1614

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

1615

def InterfacesRemoved(self, object_path, interfaces):

1616

pass

1617

1618

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1619

out_signature="s",

1620

path_keyword="object_path",

1621

connection_keyword="connection")

1622

def Introspect(self, object_path, connection):

1623

"""Overloading of standard D-Bus method.

1624

1625

Override return argument name of GetManagedObjects to be

1626

"objpath_interfaces_and_properties"

1627

"""

1628

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1629

object_path,

1630

connection)

1631

try:

1632

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

1633

1634

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

1635

# Fix argument name for the GetManagedObjects method

1636

if (if_tag.getAttribute("name")

1637

== dbus.OBJECT_MANAGER_IFACE):

1638

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

1639

if (cn.getAttribute("name")

1640

== "GetManagedObjects"):

1641

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

1642

if (arg.getAttribute("direction")

1643

== "out"):

1644

arg.setAttribute(

1645

"name",

1646

"objpath_interfaces"

1647

"_and_properties")

1648

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

1649

document.unlink()

1650

except (AttributeError, xml.dom.DOMException,

1651

xml.parsers.expat.ExpatError) as error:

1652

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

1653

exc_info=error)

1045

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

1046

exc_info=error)

1654

1047

return xmlstring

1655

1048

1656

1049

1657

1050

def datetime_to_dbus(dt, variant_level=0):

1658

1051

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

1659

1052

if dt is None:

1660

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

1053

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

1661

1054

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

1662

1055

1663

1056

1666

1059

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

1667

1060

interface names according to the "alt_interface_names" mapping.

1668

1061

Usage:

1669

1062

1670

1063

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

1671

1064

"net.example.AlternateInterface"})

1672

1065

class SampleDBusObject(dbus.service.Object):

1673

1066

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

1674

1067

def SampleDBusMethod():

1675

1068

pass

1676

1069

1677

1070

The above "SampleDBusMethod" on "SampleDBusObject" will be

1678

1071

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

1679

1072

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

1680

1073

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

1681

1074

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

1682

1075

1683

1076

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

1684

1077

(from DBusObjectWithProperties) and interfaces (from the

1685

1078

dbus_interface_annotations decorator).

1686

1079

"""

1687

1080

1688

1081

def wrapper(cls):

1689

1082

for orig_interface_name, alt_interface_name in (

1690

1083

alt_interface_names.items()):

1707

1100

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

1708

1101

# Extract the original non-method undecorated

1709

1102

# function by black magic

1710

if sys.version_info.major == 2:

1711

nonmethod_func = (dict(

1712

zip(attribute.func_code.co_freevars,

1713

attribute.__closure__))

1714

["func"].cell_contents)

1715

else:

1716

nonmethod_func = (dict(

1717

zip(attribute.__code__.co_freevars,

1718

attribute.__closure__))

1719

["func"].cell_contents)

1103

nonmethod_func = (dict(

1104

zip(attribute.func_code.co_freevars,

1105

attribute.__closure__))

1106

["func"].cell_contents)

1720

1107

# Create a new, but exactly alike, function

1721

1108

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

1722

1109

# with the alternate D-Bus interface name

1723

new_function = copy_function(nonmethod_func)

1724

1110

new_function = (dbus.service.signal(

1725

alt_interface,

1726

attribute._dbus_signature)(new_function))

1111

alt_interface, attribute._dbus_signature)

1112

(types.FunctionType(

1113

nonmethod_func.func_code,

1114

nonmethod_func.func_globals,

1115

nonmethod_func.func_name,

1116

nonmethod_func.func_defaults,

1117

nonmethod_func.func_closure)))

1727

1118

# Copy annotations, if any

1728

1119

try:

1729

1120

new_function._dbus_annotations = dict(

1730

1121

attribute._dbus_annotations)

1731

1122

except AttributeError:

1732

1123

pass

1733

1734

1124

# Define a creator of a function to call both the

1735

1125

# original and alternate functions, so both the

1736

1126

# original and alternate signals gets sent when

1739

1129

"""This function is a scope container to pass

1740

1130

func1 and func2 to the "call_both" function

1741

1131

outside of its arguments"""

1742

1743

@functools.wraps(func2)

1132

1744

1133

def call_both(*args, **kwargs):

1745

1134

"""This function will emit two D-Bus

1746

1135

signals by calling func1 and func2"""

1747

1136

func1(*args, **kwargs)

1748

1137

func2(*args, **kwargs)

1749

# Make wrapper function look like a D-Bus

1750

# signal

1751

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

1752

if name.startswith("_dbus_"):

1753

setattr(call_both, name, attr)

1754

1138

1755

1139

return call_both

1756

1140

# Create the "call_both" function and add it to

1757

1141

# the class

1767

1151

alt_interface,

1768

1152

attribute._dbus_in_signature,

1769

1153

attribute._dbus_out_signature)

1770

(copy_function(attribute)))

1154

(types.FunctionType(attribute.func_code,

1155

attribute.func_globals,

1156

attribute.func_name,

1157

attribute.func_defaults,

1158

attribute.func_closure)))

1771

1159

# Copy annotations, if any

1772

1160

try:

1773

1161

attr[attrname]._dbus_annotations = dict(

1785

1173

attribute._dbus_access,

1786

1174

attribute._dbus_get_args_options

1787

1175

["byte_arrays"])

1788

(copy_function(attribute)))

1176

(types.FunctionType(

1177

attribute.func_code,

1178

attribute.func_globals,

1179

attribute.func_name,

1180

attribute.func_defaults,

1181

attribute.func_closure)))

1789

1182

# Copy annotations, if any

1790

1183

try:

1791

1184

attr[attrname]._dbus_annotations = dict(

1800

1193

# to the class.

1801

1194

attr[attrname] = (

1802

1195

dbus_interface_annotations(alt_interface)

1803

(copy_function(attribute)))

1196

(types.FunctionType(attribute.func_code,

1197

attribute.func_globals,

1198

attribute.func_name,

1199

attribute.func_defaults,

1200

attribute.func_closure)))

1804

1201

if deprecate:

1805

1202

# Deprecate all alternate interfaces

1806

iname = "_AlternateDBusNames_interface_annotation{}"

1203

iname="_AlternateDBusNames_interface_annotation{}"

1807

1204

for interface_name in interface_names:

1808

1205

1809

1206

@dbus_interface_annotations(interface_name)

1810

1207

def func(self):

1811

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

1812

"true"}

1208

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

1209

"true" }

1813

1210

# Find an unused name

1814

1211

for aname in (iname.format(i)

1815

1212

for i in itertools.count()):

1819

1216

if interface_names:

1820

1217

# Replace the class with a new subclass of it with

1821

1218

# methods, signals, etc. as created above.

1822

if sys.version_info.major == 2:

1823

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

1824

(cls, ), attr)

1825

else:

1826

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

1827

(cls, ), attr)

1219

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

1220

(cls, ), attr)

1828

1221

return cls

1829

1222

1830

1223

return wrapper

1831

1224

1832

1225

1834

1227

"se.bsnet.fukt.Mandos"})

1835

1228

class ClientDBus(Client, DBusObjectWithProperties):

1836

1229

"""A Client class using D-Bus

1837

1230

1838

1231

Attributes:

1839

1232

dbus_object_path: dbus.ObjectPath

1840

1233

bus: dbus.SystemBus()

1841

1234

"""

1842

1235

1843

1236

runtime_expansions = (Client.runtime_expansions

1844

1237

+ ("dbus_object_path", ))

1845

1238

1846

1239

_interface = "se.recompile.Mandos.Client"

1847

1240

1848

1241

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

1849

1850

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

1242

1243

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

1851

1244

self.bus = bus

1852

1245

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

1853

1246

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

1859

1252

"/clients/" + client_object_name)

1860

1253

DBusObjectWithProperties.__init__(self, self.bus,

1861

1254

self.dbus_object_path)

1862

1255

1863

1256

def notifychangeproperty(transform_func, dbus_name,

1864

1257

type_func=lambda x: x,

1865

1258

variant_level=1,

1867

1260

_interface=_interface):

1868

1261

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

1869

1262

its changes to DBus.

1870

1263

1871

1264

transform_fun: Function that takes a value and a variant_level

1872

1265

and transforms it to a D-Bus type.

1873

1266

dbus_name: D-Bus name of the variable

1876

1269

variant_level: D-Bus variant level. Default: 1

1877

1270

"""

1878

1271

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

1879

1272

1880

1273

def setter(self, value):

1881

1274

if hasattr(self, "dbus_object_path"):

1882

1275

if (not hasattr(self, attrname) or

1889

1282

else:

1890

1283

dbus_value = transform_func(

1891

1284

type_func(value),

1892

variant_level=variant_level)

1285

variant_level = variant_level)

1893

1286

self.PropertyChanged(dbus.String(dbus_name),

1894

1287

dbus_value)

1895

1288

self.PropertiesChanged(

1896

1289

_interface,

1897

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

1898

dbus_value}),

1290

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

1291

dbus_value }),

1899

1292

dbus.Array())

1900

1293

setattr(self, attrname, value)

1901

1294

1902

1295

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

1903

1296

1904

1297

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1905

1298

approvals_pending = notifychangeproperty(dbus.Boolean,

1906

1299

"ApprovalPending",

1907

type_func=bool)

1300

type_func = bool)

1908

1301

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

1909

1302

last_enabled = notifychangeproperty(datetime_to_dbus,

1910

1303

"LastEnabled")

1911

1304

checker = notifychangeproperty(

1912

1305

dbus.Boolean, "CheckerRunning",

1913

type_func=lambda checker: checker is not None)

1306

type_func = lambda checker: checker is not None)

1914

1307

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1915

1308

"LastCheckedOK")

1916

1309

last_checker_status = notifychangeproperty(dbus.Int16,

1921

1314

"ApprovedByDefault")

1922

1315

approval_delay = notifychangeproperty(

1923

1316

dbus.UInt64, "ApprovalDelay",

1924

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

1317

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

1925

1318

approval_duration = notifychangeproperty(

1926

1319

dbus.UInt64, "ApprovalDuration",

1927

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

1320

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

1928

1321

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

1929

1322

timeout = notifychangeproperty(

1930

1323

dbus.UInt64, "Timeout",

1931

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

1324

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

1932

1325

extended_timeout = notifychangeproperty(

1933

1326

dbus.UInt64, "ExtendedTimeout",

1934

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

1327

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

1935

1328

interval = notifychangeproperty(

1936

1329

dbus.UInt64, "Interval",

1937

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

1330

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

1938

1331

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

1939

1332

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

1940

1333

invalidate_only=True)

1941

1334

1942

1335

del notifychangeproperty

1943

1336

1944

1337

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

1945

1338

try:

1946

1339

self.remove_from_connection()

1949

1342

if hasattr(DBusObjectWithProperties, "__del__"):

1950

1343

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

1951

1344

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

1952

1345

1953

1346

def checker_callback(self, source, condition,

1954

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

1347

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

1955

1348

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

1956

connection, command, *args,

1349

(connection, command), *args,

1957

1350

**kwargs)

1958

1351

exitstatus = self.last_checker_status

1959

1352

if exitstatus >= 0:

1960

1353

# Emit D-Bus signal

1961

1354

self.CheckerCompleted(dbus.Int16(exitstatus),

1962

# This is specific to GNU libC

1963

dbus.Int64(exitstatus << 8),

1355

dbus.Int64(0),

1964

1356

dbus.String(command))

1965

1357

else:

1966

1358

# Emit D-Bus signal

1967

1359

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

1968

1360

dbus.Int64(

1969

# This is specific to GNU libC

1970

(exitstatus << 8)

1971

| self.last_checker_signal),

1361

self.last_checker_signal),

1972

1362

dbus.String(command))

1973

1363

return ret

1974

1364

1975

1365

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

1976

1366

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

1977

1367

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

1981

1371

# Emit D-Bus signal

1982

1372

self.CheckerStarted(self.current_checker_command)

1983

1373

return r

1984

1374

1985

1375

def _reset_approved(self):

1986

1376

self.approved = None

1987

1377

return False

1988

1378

1989

1379

def approve(self, value=True):

1990

1380

self.approved = value

1991

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

1992

* 1000), self._reset_approved)

1381

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

1382

* 1000), self._reset_approved)

1993

1383

self.send_changedstate()

1994

1995

# D-Bus methods, signals & properties

1996

1997

# Interfaces

1998

1999

# Signals

2000

1384

1385

## D-Bus methods, signals & properties

1386

1387

## Interfaces

1388

1389

## Signals

1390

2001

1391

# CheckerCompleted - signal

2002

1392

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

2003

1393

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

2004

1394

"D-Bus signal"

2005

1395

pass

2006

1396

2007

1397

# CheckerStarted - signal

2008

1398

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

2009

1399

def CheckerStarted(self, command):

2010

1400

"D-Bus signal"

2011

1401

pass

2012

1402

2013

1403

# PropertyChanged - signal

2014

1404

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

2015

1405

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

2016

1406

def PropertyChanged(self, property, value):

2017

1407

"D-Bus signal"

2018

1408

pass

2019

1409

2020

1410

# GotSecret - signal

2021

1411

@dbus.service.signal(_interface)

2022

1412

def GotSecret(self):

2025

1415

server to mandos-client

2026

1416

"""

2027

1417

pass

2028

1418

2029

1419

# Rejected - signal

2030

1420

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

2031

1421

def Rejected(self, reason):

2032

1422

"D-Bus signal"

2033

1423

pass

2034

1424

2035

1425

# NeedApproval - signal

2036

1426

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

2037

1427

def NeedApproval(self, timeout, default):

2038

1428

"D-Bus signal"

2039

1429

return self.need_approval()

2040

2041

# Methods

2042

1430

1431

## Methods

1432

2043

1433

# Approve - method

2044

1434

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

2045

1435

def Approve(self, value):

2046

1436

self.approve(value)

2047

1437

2048

1438

# CheckedOK - method

2049

1439

@dbus.service.method(_interface)

2050

1440

def CheckedOK(self):

2051

1441

self.checked_ok()

2052

1442

2053

1443

# Enable - method

2054

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

2055

1444

@dbus.service.method(_interface)

2056

1445

def Enable(self):

2057

1446

"D-Bus method"

2058

1447

self.enable()

2059

1448

2060

1449

# StartChecker - method

2061

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

2062

1450

@dbus.service.method(_interface)

2063

1451

def StartChecker(self):

2064

1452

"D-Bus method"

2065

1453

self.start_checker()

2066

1454

2067

1455

# Disable - method

2068

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

2069

1456

@dbus.service.method(_interface)

2070

1457

def Disable(self):

2071

1458

"D-Bus method"

2072

1459

self.disable()

2073

1460

2074

1461

# StopChecker - method

2075

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

2076

1462

@dbus.service.method(_interface)

2077

1463

def StopChecker(self):

2078

1464

self.stop_checker()

2079

2080

# Properties

2081

1465

1466

## Properties

1467

2082

1468

# ApprovalPending - property

2083

1469

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

2084

1470

def ApprovalPending_dbus_property(self):

2085

1471

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

2086

1472

2087

1473

# ApprovedByDefault - property

2088

1474

@dbus_service_property(_interface,

2089

1475

signature="b",

2092

1478

if value is None: # get

2093

1479

return dbus.Boolean(self.approved_by_default)

2094

1480

self.approved_by_default = bool(value)

2095

1481

2096

1482

# ApprovalDelay - property

2097

1483

@dbus_service_property(_interface,

2098

1484

signature="t",

2102

1488

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

2103

1489

* 1000)

2104

1490

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

2105

1491

2106

1492

# ApprovalDuration - property

2107

1493

@dbus_service_property(_interface,

2108

1494

signature="t",

2112

1498

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

2113

1499

* 1000)

2114

1500

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

2115

1501

2116

1502

# Name - property

2117

@dbus_annotations(

2118

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

2119

1503

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

2120

1504

def Name_dbus_property(self):

2121

1505

return dbus.String(self.name)

2122

2123

# KeyID - property

2124

@dbus_annotations(

2125

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

2126

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

2127

def KeyID_dbus_property(self):

2128

return dbus.String(self.key_id)

2129

1506

2130

1507

# Fingerprint - property

2131

@dbus_annotations(

2132

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

2133

1508

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

2134

1509

def Fingerprint_dbus_property(self):

2135

1510

return dbus.String(self.fingerprint)

2136

1511

2137

1512

# Host - property

2138

1513

@dbus_service_property(_interface,

2139

1514

signature="s",

2142

1517

if value is None: # get

2143

1518

return dbus.String(self.host)

2144

1519

self.host = str(value)

2145

1520

2146

1521

# Created - property

2147

@dbus_annotations(

2148

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

2149

1522

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

2150

1523

def Created_dbus_property(self):

2151

1524

return datetime_to_dbus(self.created)

2152

1525

2153

1526

# LastEnabled - property

2154

1527

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

2155

1528

def LastEnabled_dbus_property(self):

2156

1529

return datetime_to_dbus(self.last_enabled)

2157

1530

2158

1531

# Enabled - property

2159

1532

@dbus_service_property(_interface,

2160

1533

signature="b",

2166

1539

self.enable()

2167

1540

else:

2168

1541

self.disable()

2169

1542

2170

1543

# LastCheckedOK - property

2171

1544

@dbus_service_property(_interface,

2172

1545

signature="s",

2176

1549

self.checked_ok()

2177

1550

return

2178

1551

return datetime_to_dbus(self.last_checked_ok)

2179

1552

2180

1553

# LastCheckerStatus - property

2181

1554

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

2182

1555

def LastCheckerStatus_dbus_property(self):

2183

1556

return dbus.Int16(self.last_checker_status)

2184

1557

2185

1558

# Expires - property

2186

1559

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

2187

1560

def Expires_dbus_property(self):

2188

1561

return datetime_to_dbus(self.expires)

2189

1562

2190

1563

# LastApprovalRequest - property

2191

1564

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

2192

1565

def LastApprovalRequest_dbus_property(self):

2193

1566

return datetime_to_dbus(self.last_approval_request)

2194

1567

2195

1568

# Timeout - property

2196

1569

@dbus_service_property(_interface,

2197

1570

signature="t",

2212

1585

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

2213

1586

is None):

2214

1587

return

2215

GLib.source_remove(self.disable_initiator_tag)

2216

self.disable_initiator_tag = GLib.timeout_add(

1588

gobject.source_remove(self.disable_initiator_tag)

1589

self.disable_initiator_tag = gobject.timeout_add(

2217

1590

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

2218

1591

self.disable)

2219

1592

2220

1593

# ExtendedTimeout - property

2221

1594

@dbus_service_property(_interface,

2222

1595

signature="t",

2226

1599

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

2227

1600

* 1000)

2228

1601

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

2229

1602

2230

1603

# Interval - property

2231

1604

@dbus_service_property(_interface,

2232

1605

signature="t",

2239

1612

return

2240

1613

if self.enabled:

2241

1614

# Reschedule checker run

2242

GLib.source_remove(self.checker_initiator_tag)

2243

self.checker_initiator_tag = GLib.timeout_add(

1615

gobject.source_remove(self.checker_initiator_tag)

1616

self.checker_initiator_tag = gobject.timeout_add(

2244

1617

value, self.start_checker)

2245

self.start_checker() # Start one now, too

2246

1618

self.start_checker() # Start one now, too

1619

2247

1620

# Checker - property

2248

1621

@dbus_service_property(_interface,

2249

1622

signature="s",

2252

1625

if value is None: # get

2253

1626

return dbus.String(self.checker_command)

2254

1627

self.checker_command = str(value)

2255

1628

2256

1629

# CheckerRunning - property

2257

1630

@dbus_service_property(_interface,

2258

1631

signature="b",

2264

1637

self.start_checker()

2265

1638

else:

2266

1639

self.stop_checker()

2267

1640

2268

1641

# ObjectPath - property

2269

@dbus_annotations(

2270

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

2271

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

2272

1642

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

2273

1643

def ObjectPath_dbus_property(self):

2274

return self.dbus_object_path # is already a dbus.ObjectPath

2275

1644

return self.dbus_object_path # is already a dbus.ObjectPath

1645

2276

1646

# Secret = property

2277

@dbus_annotations(

2278

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

2279

"invalidates"})

2280

1647

@dbus_service_property(_interface,

2281

1648

signature="ay",

2282

1649

access="write",

2283

1650

byte_arrays=True)

2284

1651

def Secret_dbus_property(self, value):

2285

1652

self.secret = bytes(value)

2286

1653

2287

1654

del _interface

2288

1655

2289

1656

2290

class ProxyClient:

2291

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

1657

class ProxyClient(object):

1658

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

2292

1659

self._pipe = child_pipe

2293

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

1660

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

2294

1661

if not self._pipe.recv():

2295

raise KeyError(key_id or fpr)

2296

1662

raise KeyError()

1663

2297

1664

def __getattribute__(self, name):

2298

if name == "_pipe":

1665

if name == '_pipe':

2299

1666

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

2300

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

1667

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

2301

1668

data = self._pipe.recv()

2302

if data[0] == "data":

1669

if data[0] == 'data':

2303

1670

return data[1]

2304

if data[0] == "function":

2305

1671

if data[0] == 'function':

1672

2306

1673

def func(*args, **kwargs):

2307

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

1674

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

2308

1675

return self._pipe.recv()[1]

2309

1676

2310

1677

return func

2311

1678

2312

1679

def __setattr__(self, name, value):

2313

if name == "_pipe":

1680

if name == '_pipe':

2314

1681

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

2315

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

1682

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

2316

1683

2317

1684

2318

1685

class ClientHandler(socketserver.BaseRequestHandler, object):

2319

1686

"""A class to handle client connections.

2320

1687

2321

1688

Instantiated once for each connection to handle it.

2322

1689

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

2323

1690

2324

1691

def handle(self):

2325

1692

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

2326

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

2327

str(self.client_address))

2328

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

2329

2330

session = gnutls.ClientSession(self.request)

2331

2332

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

2333

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

2334

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

2335

# "+DHE-DSS"))

1693

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

1694

str(self.client_address))

1695

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

1696

self.server.child_pipe.fileno())

1697

1698

session = gnutls.connection.ClientSession(

1699

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

1700

1701

# Note: gnutls.connection.X509Credentials is really a

1702

# generic GnuTLS certificate credentials object so long as

1703

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

1704

# here despite using OpenPGP certificates.

1705

1706

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

1707

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

1708

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

1709

# "+DHE-DSS"))

2336

1710

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

2337

1711

priority = self.server.gnutls_priority

2338

1712

if priority is None:

2339

1713

priority = "NORMAL"

2340

gnutls.priority_set_direct(session,

2341

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

2342

1714

gnutls.library.functions.gnutls_priority_set_direct(

1715

session._c_object, priority, None)

1716

2343

1717

# Start communication using the Mandos protocol

2344

1718

# Get protocol number

2345

1719

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

2346

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

1720

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

2347

1721

try:

2348

1722

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

2349

1723

raise RuntimeError(line)

2350

1724

except (ValueError, IndexError, RuntimeError) as error:

2351

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

1725

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

2352

1726

return

2353

1727

2354

1728

# Start GnuTLS connection

2355

1729

try:

2356

1730

session.handshake()

2357

except gnutls.Error as error:

2358

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

1731

except gnutls.errors.GNUTLSError as error:

1732

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

2359

1733

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

2360

1734

# established. Just abandon the request.

2361

1735

return

2362

log.debug("Handshake succeeded")

2363

1736

logger.debug("Handshake succeeded")

1737

2364

1738

approval_required = False

2365

1739

try:

2366

if gnutls.has_rawpk:

2367

fpr = b""

2368

try:

2369

key_id = self.key_id(

2370

self.peer_certificate(session))

2371

except (TypeError, gnutls.Error) as error:

2372

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

2373

return

2374

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

2375

key_id.decode("utf-8",

2376

errors="replace"))

2377

2378

else:

2379

key_id = b""

2380

try:

2381

fpr = self.fingerprint(

2382

self.peer_certificate(session))

2383

except (TypeError, gnutls.Error) as error:

2384

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

2385

return

2386

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

2387

2388

try:

2389

client = ProxyClient(child_pipe, key_id, fpr,

1740

try:

1741

fpr = self.fingerprint(

1742

self.peer_certificate(session))

1743

except (TypeError,

1744

gnutls.errors.GNUTLSError) as error:

1745

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

1746

return

1747

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

1748

1749

try:

1750

client = ProxyClient(child_pipe, fpr,

2390

1751

self.client_address)

2391

1752

except KeyError:

2392

1753

return

2393

1754

2394

1755

if client.approval_delay:

2395

1756

delay = client.approval_delay

2396

1757

client.approvals_pending += 1

2397

1758

approval_required = True

2398

1759

2399

1760

while True:

2400

1761

if not client.enabled:

2401

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

1762

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

1763

client.name)

2402

1764

if self.server.use_dbus:

2403

1765

# Emit D-Bus signal

2404

1766

client.Rejected("Disabled")

2405

1767

return

2406

1768

2407

1769

if client.approved or not client.approval_delay:

2408

# We are approved or approval is disabled

1770

#We are approved or approval is disabled

2409

1771

break

2410

1772

elif client.approved is None:

2411

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

2412

client.name)

1773

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

1774

client.name)

2413

1775

if self.server.use_dbus:

2414

1776

# Emit D-Bus signal

2415

1777

client.NeedApproval(

2416

1778

client.approval_delay.total_seconds()

2417

1779

* 1000, client.approved_by_default)

2418

1780

else:

2419

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

2420

client.name)

1781

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

1782

client.name)

2421

1783

if self.server.use_dbus:

2422

1784

# Emit D-Bus signal

2423

1785

client.Rejected("Denied")

2424

1786

return

2425

2426

# wait until timeout or approved

1787

1788

#wait until timeout or approved

2427

1789

time = datetime.datetime.now()

2428

1790

client.changedstate.acquire()

2429

1791

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

2431

1793

time2 = datetime.datetime.now()

2432

1794

if (time2 - time) >= delay:

2433

1795

if not client.approved_by_default:

2434

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

2435

" waiting for approval",

2436

client.name)

1796

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

1797

" waiting for approval",

1798

client.name)

2437

1799

if self.server.use_dbus:

2438

1800

# Emit D-Bus signal

2439

1801

client.Rejected("Approval timed out")

2442

1804

break

2443

1805

else:

2444

1806

delay -= time2 - time

2445

2446

try:

2447

session.send(client.secret)

2448

except gnutls.Error as error:

2449

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

2450

return

2451

2452

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

1807

1808

sent_size = 0

1809

while sent_size < len(client.secret):

1810

try:

1811

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

1812

except gnutls.errors.GNUTLSError as error:

1813

logger.warning("gnutls send failed",

1814

exc_info=error)

1815

return

1816

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

1817

len(client.secret) - (sent_size

1818

+ sent))

1819

sent_size += sent

1820

1821

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

2453

1822

# bump the timeout using extended_timeout

2454

1823

client.bump_timeout(client.extended_timeout)

2455

1824

if self.server.use_dbus:

2456

1825

# Emit D-Bus signal

2457

1826

client.GotSecret()

2458

1827

2459

1828

finally:

2460

1829

if approval_required:

2461

1830

client.approvals_pending -= 1

2462

1831

try:

2463

1832

session.bye()

2464

except gnutls.Error as error:

2465

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

2466

1833

except gnutls.errors.GNUTLSError as error:

1834

logger.warning("GnuTLS bye failed",

1835

exc_info=error)

1836

2467

1837

@staticmethod

2468

1838

def peer_certificate(session):

2469

"Return the peer's certificate as a bytestring"

2470

try:

2471

cert_type = gnutls.certificate_type_get2(

2472

session, gnutls.CTYPE_PEERS)

2473

except AttributeError:

2474

cert_type = gnutls.certificate_type_get(session)

2475

if gnutls.has_rawpk:

2476

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2477

else:

2478

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2479

# If not a valid certificate type...

2480

if cert_type not in valid_cert_types:

2481

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

2482

valid_cert_types)

2483

# ...return invalid data

2484

return b""

1839

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

1840

# If not an OpenPGP certificate...

1841

if (gnutls.library.functions.gnutls_certificate_type_get(

1842

session._c_object)

1843

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1844

# ...do the normal thing

1845

return session.peer_certificate

2485

1846

list_size = ctypes.c_uint(1)

2486

cert_list = (gnutls.certificate_get_peers

2487

(session, ctypes.byref(list_size)))

1847

cert_list = (gnutls.library.functions

1848

.gnutls_certificate_get_peers

1849

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

2488

1850

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

2489

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

1851

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

1852

" certificate")

2490

1853

if list_size.value == 0:

2491

1854

return None

2492

1855

cert = cert_list[0]

2493

1856

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

2494

2495

@staticmethod

2496

def key_id(certificate):

2497

"Convert a certificate bytestring to a hexdigit key ID"

2498

# New GnuTLS "datum" with the public key

2499

datum = gnutls.datum_t(

2500

ctypes.cast(ctypes.c_char_p(certificate),

2501

ctypes.POINTER(ctypes.c_ubyte)),

2502

ctypes.c_uint(len(certificate)))

2503

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

2504

# New empty GnuTLS certificate

2505

pubkey = gnutls.pubkey_t()

2506

gnutls.pubkey_init(ctypes.byref(pubkey))

2507

# Import the raw public key into the certificate

2508

gnutls.pubkey_import(pubkey,

2509

ctypes.byref(datum),

2510

gnutls.X509_FMT_DER)

2511

# New buffer for the key ID

2512

buf = ctypes.create_string_buffer(32)

2513

buf_len = ctypes.c_size_t(len(buf))

2514

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

2515

gnutls.pubkey_get_key_id(

2516

pubkey,

2517

gnutls.KEYID_USE_SHA256,

2518

ctypes.cast(ctypes.byref(buf),

2519

ctypes.POINTER(ctypes.c_ubyte)),

2520

ctypes.byref(buf_len))

2521

# Deinit the certificate

2522

gnutls.pubkey_deinit(pubkey)

2523

2524

# Convert the buffer to a Python bytestring

2525

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

2526

# Convert the bytestring to hexadecimal notation

2527

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

2528

return hex_key_id

2529

1857

2530

1858

@staticmethod

2531

1859

def fingerprint(openpgp):

2532

1860

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2533

1861

# New GnuTLS "datum" with the OpenPGP public key

2534

datum = gnutls.datum_t(

1862

datum = gnutls.library.types.gnutls_datum_t(

2535

1863

ctypes.cast(ctypes.c_char_p(openpgp),

2536

1864

ctypes.POINTER(ctypes.c_ubyte)),

2537

1865

ctypes.c_uint(len(openpgp)))

2538

1866

# New empty GnuTLS certificate

2539

crt = gnutls.openpgp_crt_t()

2540

gnutls.openpgp_crt_init(ctypes.byref(crt))

1867

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1868

gnutls.library.functions.gnutls_openpgp_crt_init(

1869

ctypes.byref(crt))

2541

1870

# Import the OpenPGP public key into the certificate

2542

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

2543

gnutls.OPENPGP_FMT_RAW)

1871

gnutls.library.functions.gnutls_openpgp_crt_import(

1872

crt, ctypes.byref(datum),

1873

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

2544

1874

# Verify the self signature in the key

2545

1875

crtverify = ctypes.c_uint()

2546

gnutls.openpgp_crt_verify_self(crt, 0,

2547

ctypes.byref(crtverify))

1876

gnutls.library.functions.gnutls_openpgp_crt_verify_self(

1877

crt, 0, ctypes.byref(crtverify))

2548

1878

if crtverify.value != 0:

2549

gnutls.openpgp_crt_deinit(crt)

2550

raise gnutls.CertificateSecurityError(code

2551

=crtverify.value)

1879

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1880

raise gnutls.errors.CertificateSecurityError(

1881

"Verify failed")

2552

1882

# New buffer for the fingerprint

2553

1883

buf = ctypes.create_string_buffer(20)

2554

1884

buf_len = ctypes.c_size_t()

2555

1885

# Get the fingerprint from the certificate into the buffer

2556

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

2557

ctypes.byref(buf_len))

1886

gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(

1887

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

2558

1888

# Deinit the certificate

2559

gnutls.openpgp_crt_deinit(crt)

1889

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2560

1890

# Convert the buffer to a Python bytestring

2561

1891

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

2562

1892

# Convert the bytestring to hexadecimal notation

2564

1894

return hex_fpr

2565

1895

2566

1896

2567

class MultiprocessingMixIn:

1897

class MultiprocessingMixIn(object):

2568

1898

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

2569

1899

2570

1900

def sub_process_main(self, request, address):

2571

1901

try:

2572

1902

self.finish_request(request, address)

2573

1903

except Exception:

2574

1904

self.handle_error(request, address)

2575

1905

self.close_request(request)

2576

1906

2577

1907

def process_request(self, request, address):

2578

1908

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

2579

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

2580

args=(request, address))

1909

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

1910

args = (request, address))

2581

1911

proc.start()

2582

1912

return proc

2583

1913

2584

1914

2585

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1915

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2586

1916

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

2587

1917

2588

1918

def process_request(self, request, client_address):

2589

1919

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

2590

1920

2591

1921

This function creates a new pipe in self.pipe

2592

1922

"""

2593

1923

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2594

1924

2595

1925

proc = MultiprocessingMixIn.process_request(self, request,

2596

1926

client_address)

2597

1927

self.child_pipe.close()

2598

1928

self.add_pipe(parent_pipe, proc)

2599

1929

2600

1930

def add_pipe(self, parent_pipe, proc):

2601

1931

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

2602

1932

raise NotImplementedError()

2603

1933

2604

1934

2605

1935

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2606

socketserver.TCPServer):

2607

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

2608

1936

socketserver.TCPServer, object):

1937

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

1938

2609

1939

Attributes:

2610

1940

enabled: Boolean; whether this server is activated yet

2611

1941

interface: None or a network interface name (string)

2612

1942

use_ipv6: Boolean; to use IPv6 or not

2613

1943

"""

2614

1944

2615

1945

def __init__(self, server_address, RequestHandlerClass,

2616

1946

interface=None,

2617

1947

use_ipv6=True,

2627

1957

self.socketfd = socketfd

2628

1958

# Save the original socket.socket() function

2629

1959

self.socket_socket = socket.socket

2630

2631

1960

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

2632

#

1961

#

2633

1962

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

2634

1963

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

2635

1964

# patching socket.socket.)

2636

#

1965

#

2637

1966

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

2638

1967

@functools.wraps(socket.socket)

2639

1968

def socket_wrapper(*args, **kwargs):

2651

1980

# socket_wrapper(), if socketfd was set.

2652

1981

socketserver.TCPServer.__init__(self, server_address,

2653

1982

RequestHandlerClass)

2654

1983

2655

1984

def server_bind(self):

2656

1985

"""This overrides the normal server_bind() function

2657

1986

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

2658

1987

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

2659

global SO_BINDTODEVICE

2660

1988

if self.interface is not None:

2661

1989

if SO_BINDTODEVICE is None:

2662

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

2663

# common enough.

2664

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

2665

SO_BINDTODEVICE = 25

2666

try:

2667

self.socket.setsockopt(

2668

socket.SOL_SOCKET, SO_BINDTODEVICE,

2669

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

2670

except socket.error as error:

2671

if error.errno == errno.EPERM:

2672

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

2673

self.interface)

2674

elif error.errno == errno.ENOPROTOOPT:

2675

log.error("SO_BINDTODEVICE not available; cannot"

2676

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

2677

elif error.errno == errno.ENODEV:

2678

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

2679

" bind", self.interface)

2680

else:

2681

raise

1990

logger.error("SO_BINDTODEVICE does not exist;"

1991

" cannot bind to interface %s",

1992

self.interface)

1993

else:

1994

try:

1995

self.socket.setsockopt(

1996

socket.SOL_SOCKET, SO_BINDTODEVICE,

1997

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

1998

except socket.error as error:

1999

if error.errno == errno.EPERM:

2000

logger.error("No permission to bind to"

2001

" interface %s", self.interface)

2002

elif error.errno == errno.ENOPROTOOPT:

2003

logger.error("SO_BINDTODEVICE not available;"

2004

" cannot bind to interface %s",

2005

self.interface)

2006

elif error.errno == errno.ENODEV:

2007

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

2008

" cannot bind", self.interface)

2009

else:

2010

raise

2682

2011

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

2683

2012

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

2684

if self.server_address[1]:

2685

self.allow_reuse_address = True

2686

2013

if not self.server_address[0]:

2687

2014

if self.address_family == socket.AF_INET6:

2688

any_address = "::" # in6addr_any

2015

any_address = "::" # in6addr_any

2689

2016

else:

2690

any_address = "0.0.0.0" # INADDR_ANY

2017

any_address = "0.0.0.0" # INADDR_ANY

2691

2018

self.server_address = (any_address,

2692

2019

self.server_address[1])

2693

2020

elif not self.server_address[1]:

2703

2030

2704

2031

class MandosServer(IPv6_TCPServer):

2705

2032

"""Mandos server.

2706

2033

2707

2034

Attributes:

2708

2035

clients: set of Client objects

2709

2036

gnutls_priority GnuTLS priority string

2710

2037

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

2711

2712

Assumes a GLib.MainLoop event loop.

2038

2039

Assumes a gobject.MainLoop event loop.

2713

2040

"""

2714

2041

2715

2042

def __init__(self, server_address, RequestHandlerClass,

2716

2043

interface=None,

2717

2044

use_ipv6=True,

2727

2054

self.gnutls_priority = gnutls_priority

2728

2055

IPv6_TCPServer.__init__(self, server_address,

2729

2056

RequestHandlerClass,

2730

interface=interface,

2731

use_ipv6=use_ipv6,

2732

socketfd=socketfd)

2733

2057

interface = interface,

2058

use_ipv6 = use_ipv6,

2059

socketfd = socketfd)

2060

2734

2061

def server_activate(self):

2735

2062

if self.enabled:

2736

2063

return socketserver.TCPServer.server_activate(self)

2737

2064

2738

2065

def enable(self):

2739

2066

self.enabled = True

2740

2067

2741

2068

def add_pipe(self, parent_pipe, proc):

2742

2069

# Call "handle_ipc" for both data and EOF events

2743

GLib.io_add_watch(

2744

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

2745

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

2070

gobject.io_add_watch(

2071

parent_pipe.fileno(),

2072

gobject.IO_IN | gobject.IO_HUP,

2746

2073

functools.partial(self.handle_ipc,

2747

parent_pipe=parent_pipe,

2748

proc=proc))

2749

2074

parent_pipe = parent_pipe,

2075

proc = proc))

2076

2750

2077

def handle_ipc(self, source, condition,

2751

2078

parent_pipe=None,

2752

proc=None,

2079

proc = None,

2753

2080

client_object=None):

2754

2081

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

2755

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

2082

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

2756

2083

# Wait for other process to exit

2757

2084

proc.join()

2758

2085

return False

2759

2086

2760

2087

# Read a request from the child

2761

2088

request = parent_pipe.recv()

2762

2089

command = request[0]

2763

2764

if command == "init":

2765

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

2766

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

2767

address = request[3]

2768

2769

for c in self.clients.values():

2770

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2771

"27AE41E4649B934CA495991B7852B855"):

2772

continue

2773

if key_id and c.key_id == key_id:

2774

client = c

2775

break

2776

if fpr and c.fingerprint == fpr:

2090

2091

if command == 'init':

2092

fpr = request[1]

2093

address = request[2]

2094

2095

for c in self.clients.itervalues():

2096

if c.fingerprint == fpr:

2777

2097

client = c

2778

2098

break

2779

2099

else:

2780

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

2781

" %s", key_id or fpr, address)

2100

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

2101

"dress: %s", fpr, address)

2782

2102

if self.use_dbus:

2783

2103

# Emit D-Bus signal

2784

mandos_dbus_service.ClientNotFound(key_id or fpr,

2104

mandos_dbus_service.ClientNotFound(fpr,

2785

2105

address[0])

2786

2106

parent_pipe.send(False)

2787

2107

return False

2788

2789

GLib.io_add_watch(

2790

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

2791

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

2108

2109

gobject.io_add_watch(

2110

parent_pipe.fileno(),

2111

gobject.IO_IN | gobject.IO_HUP,

2792

2112

functools.partial(self.handle_ipc,

2793

parent_pipe=parent_pipe,

2794

proc=proc,

2795

client_object=client))

2113

parent_pipe = parent_pipe,

2114

proc = proc,

2115

client_object = client))

2796

2116

parent_pipe.send(True)

2797

2117

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

2798

2118

# same fileno

2799

2119

return False

2800

if command == "funcall":

2120

if command == 'funcall':

2801

2121

funcname = request[1]

2802

2122

args = request[2]

2803

2123

kwargs = request[3]

2804

2805

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

2124

2125

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

2806

2126

funcname)(*args,

2807

2127

**kwargs)))

2808

2809

if command == "getattr":

2128

2129

if command == 'getattr':

2810

2130

attrname = request[1]

2811

if isinstance(client_object.__getattribute__(attrname),

2812

collections.abc.Callable):

2813

parent_pipe.send(("function", ))

2131

if callable(client_object.__getattribute__(attrname)):

2132

parent_pipe.send(('function', ))

2814

2133

else:

2815

2134

parent_pipe.send((

2816

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

2817

2818

if command == "setattr":

2135

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

2136

2137

if command == 'setattr':

2819

2138

attrname = request[1]

2820

2139

value = request[2]

2821

2140

setattr(client_object, attrname, value)

2822

2141

2823

2142

return True

2824

2143

2825

2144

2826

2145

def rfc3339_duration_to_delta(duration):

2827

2146

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

2828

2829

>>> timedelta = datetime.timedelta

2830

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

2831

True

2832

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

2833

True

2834

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

2835

True

2836

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

2837

True

2838

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

2839

True

2840

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

2841

True

2842

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

2843

True

2844

>>> del timedelta

2147

2148

>>> rfc3339_duration_to_delta("P7D")

2149

datetime.timedelta(7)

2150

>>> rfc3339_duration_to_delta("PT60S")

2151

datetime.timedelta(0, 60)

2152

>>> rfc3339_duration_to_delta("PT60M")

2153

datetime.timedelta(0, 3600)

2154

>>> rfc3339_duration_to_delta("PT24H")

2155

datetime.timedelta(1)

2156

>>> rfc3339_duration_to_delta("P1W")

2157

datetime.timedelta(7)

2158

>>> rfc3339_duration_to_delta("PT5M30S")

2159

datetime.timedelta(0, 330)

2160

>>> rfc3339_duration_to_delta("P1DT3M20S")

2161

datetime.timedelta(1, 200)

2845

2162

"""

2846

2163

2847

2164

# Parsing an RFC 3339 duration with regular expressions is not

2848

2165

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

2849

2166

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

2850

2167

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

2851

2168

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

2852

2169

# avoid excessive use of external libraries.

2853

2170

2854

2171

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

2172

Token = collections.namedtuple("Token",

2173

("regexp", # To match token; if

2174

# "value" is not None,

2175

# must have a "group"

2176

# containing digits

2177

"value", # datetime.timedelta or

2178

# None

2179

"followers")) # Tokens valid after

2180

# this token

2855

2181

Token = collections.namedtuple("Token", (

2856

2182

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

2857

2183

# a "group" containing digits

2889

2215

frozenset((token_year, token_month,

2890

2216

token_day, token_time,

2891

2217

token_week)))

2892

# Define starting values:

2893

# Value so far

2894

value = datetime.timedelta()

2218

# Define starting values

2219

value = datetime.timedelta() # Value so far

2895

2220

found_token = None

2896

# Following valid tokens

2897

followers = frozenset((token_duration, ))

2898

# String left to parse

2899

s = duration

2221

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

2222

s = duration # String left to parse

2900

2223

# Loop until end token is found

2901

2224

while found_token is not token_end:

2902

2225

# Search for any currently valid tokens

2918

2241

break

2919

2242

else:

2920

2243

# No currently valid tokens were found

2921

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

2922

.format(duration))

2244

raise ValueError("Invalid RFC 3339 duration")

2923

2245

# End token found

2924

2246

return value

2925

2247

2926

2248

2927

2249

def string_to_delta(interval):

2928

2250

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

2929

2930

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

2931

True

2932

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

2933

True

2934

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

2935

True

2936

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

2937

True

2938

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

2939

True

2940

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

2941

True

2251

2252

>>> string_to_delta('7d')

2253

datetime.timedelta(7)

2254

>>> string_to_delta('60s')

2255

datetime.timedelta(0, 60)

2256

>>> string_to_delta('60m')

2257

datetime.timedelta(0, 3600)

2258

>>> string_to_delta('24h')

2259

datetime.timedelta(1)

2260

>>> string_to_delta('1w')

2261

datetime.timedelta(7)

2262

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

2263

datetime.timedelta(0, 330)

2942

2264

"""

2943

2265

2944

2266

try:

2945

2267

return rfc3339_duration_to_delta(interval)

2946

2268

except ValueError:

2947

2269

pass

2948

2270

2949

2271

timevalue = datetime.timedelta(0)

2950

2272

for s in interval.split():

2951

2273

try:

2969

2291

return timevalue

2970

2292

2971

2293

2972

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

2294

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

2973

2295

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

2974

2296

2975

2297

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

2976

2298

if os.fork():

2977

2299

sys.exit()

2995

2317

2996

2318

2997

2319

def main():

2998

2320

2999

2321

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

3000

2322

# Parsing of options, both command line and config file

3001

2323

3002

2324

parser = argparse.ArgumentParser()

3003

2325

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

3004

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

2326

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

3005

2327

help="show version number and exit")

3006

2328

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

3007

2329

help="Bind to interface IF")

3043

2365

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

3044

2366

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

3045

2367

default=None)

3046

2368

3047

2369

options = parser.parse_args()

3048

2370

2371

if options.check:

2372

import doctest

2373

fail_count, test_count = doctest.testmod()

2374

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

2375

3049

2376

# Default values for config file for server-global settings

3050

if gnutls.has_rawpk:

3051

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

3052

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

3053

else:

3054

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

3055

":+SIGN-DSA-SHA256")

3056

server_defaults = {"interface": "",

3057

"address": "",

3058

"port": "",

3059

"debug": "False",

3060

"priority": priority,

3061

"servicename": "Mandos",

3062

"use_dbus": "True",

3063

"use_ipv6": "True",

3064

"debuglevel": "",

3065

"restore": "True",

3066

"socket": "",

3067

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

3068

"foreground": "False",

3069

"zeroconf": "True",

3070

}

3071

del priority

3072

2377

server_defaults = { "interface": "",

2378

"address": "",

2379

"port": "",

2380

"debug": "False",

2381

"priority":

2382

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

2383

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

2384

"servicename": "Mandos",

2385

"use_dbus": "True",

2386

"use_ipv6": "True",

2387

"debuglevel": "",

2388

"restore": "True",

2389

"socket": "",

2390

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

2391

"foreground": "False",

2392

"zeroconf": "True",

2393

}

2394

3073

2395

# Parse config file for server-global settings

3074

server_config = configparser.ConfigParser(server_defaults)

2396

server_config = configparser.SafeConfigParser(server_defaults)

3075

2397

del server_defaults

3076

2398

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

3077

# Convert the ConfigParser object to a dict

2399

# Convert the SafeConfigParser object to a dict

3078

2400

server_settings = server_config.defaults()

3079

2401

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

3080

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

3081

"foreground", "zeroconf"):

2402

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

3082

2403

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

3083

2404

option)

3084

2405

if server_settings["port"]:

3094

2415

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

3095

2416

["socket"])

3096

2417

del server_config

3097

2418

3098

2419

# Override the settings from the config file with command line

3099

2420

# options, if set.

3100

2421

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

3118

2439

if server_settings["debug"]:

3119

2440

server_settings["foreground"] = True

3120

2441

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

3121

2442

3122

2443

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

3123

2444

3124

2445

if (not server_settings["zeroconf"]

3125

2446

and not (server_settings["port"]

3126

2447

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

3127

2448

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

3128

2449

3129

2450

# For convenience

3130

2451

debug = server_settings["debug"]

3131

2452

debuglevel = server_settings["debuglevel"]

3135

2456

stored_state_file)

3136

2457

foreground = server_settings["foreground"]

3137

2458

zeroconf = server_settings["zeroconf"]

3138

2459

3139

2460

if debug:

3140

2461

initlogger(debug, logging.DEBUG)

3141

2462

else:

3144

2465

else:

3145

2466

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

3146

2467

initlogger(debug, level)

3147

2468

3148

2469

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

3149

2470

syslogger.setFormatter(

3150

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

3151

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

2471

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

2472

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

3152

2473

server_settings["servicename"])))

3153

2474

3154

2475

# Parse config file with clients

3155

client_config = configparser.ConfigParser(Client.client_defaults)

2476

client_config = configparser.SafeConfigParser(Client

2477

.client_defaults)

3156

2478

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

3157

2479

"clients.conf"))

3158

2480

3159

2481

global mandos_dbus_service

3160

2482

mandos_dbus_service = None

3161

2483

3162

2484

socketfd = None

3163

2485

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

3164

2486

socketfd = server_settings["socket"]

3176

2498

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

3177

2499

pidfile = None

3178

2500

try:

3179

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

2501

pidfile = open(pidfilename, "w")

3180

2502

except IOError as e:

3181

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

3182

exc_info=e)

3183

3184

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

3185

("mandos", "mandos"),

3186

("nobody", "nogroup")):

2503

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

2504

exc_info=e)

2505

2506

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

3187

2507

try:

3188

2508

uid = pwd.getpwnam(name).pw_uid

3189

gid = pwd.getpwnam(group).pw_gid

2509

gid = pwd.getpwnam(name).pw_gid

3190

2510

break

3191

2511

except KeyError:

3192

2512

continue

3196

2516

try:

3197

2517

os.setgid(gid)

3198

2518

os.setuid(uid)

3199

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

3200

2519

except OSError as error:

3201

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

3202

os.strerror(error.errno))

3203

2520

if error.errno != errno.EPERM:

3204

2521

raise

3205

2522

3206

2523

if debug:

3207

2524

# Enable all possible GnuTLS debugging

3208

2525

3209

2526

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

3210

2527

# - GnuTLS manual

3211

gnutls.global_set_log_level(11)

3212

3213

@gnutls.log_func

2528

gnutls.library.functions.gnutls_global_set_log_level(11)

2529

2530

@gnutls.library.types.gnutls_log_func

3214

2531

def debug_gnutls(level, string):

3215

log.debug("GnuTLS: %s",

3216

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

3217

3218

gnutls.global_set_log_function(debug_gnutls)

3219

2532

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

2533

2534

gnutls.library.functions.gnutls_global_set_log_function(

2535

debug_gnutls)

2536

3220

2537

# Redirect stdin so all checkers get /dev/null

3221

2538

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

3222

2539

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

3223

2540

if null > 2:

3224

2541

os.close(null)

3225

2542

3226

2543

# Need to fork before connecting to D-Bus

3227

2544

if not foreground:

3228

2545

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

3229

2546

daemon()

3230

3231

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

3232

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

3233

# need to inform GLib that threads will be used.

3234

GLib.threads_init()

3235

2547

2548

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

2549

# need to inform gobject that threads will be used.

2550

gobject.threads_init()

2551

3236

2552

global main_loop

3237

2553

# From the Avahi example code

3238

2554

DBusGMainLoop(set_as_default=True)

3239

main_loop = GLib.MainLoop()

2555

main_loop = gobject.MainLoop()

3240

2556

bus = dbus.SystemBus()

3241

2557

# End of Avahi example code

3242

2558

if use_dbus:

3247

2563

old_bus_name = dbus.service.BusName(

3248

2564

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

3249

2565

do_not_queue=True)

3250

except dbus.exceptions.DBusException as e:

3251

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

2566

except dbus.exceptions.NameExistsException as e:

2567

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

3252

2568

use_dbus = False

3253

2569

server_settings["use_dbus"] = False

3254

2570

tcp_server.use_dbus = False

3255

2571

if zeroconf:

3256

2572

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3257

2573

service = AvahiServiceToSyslog(

3258

name=server_settings["servicename"],

3259

servicetype="_mandos._tcp",

3260

protocol=protocol,

3261

bus=bus)

2574

name = server_settings["servicename"],

2575

servicetype = "_mandos._tcp",

2576

protocol = protocol,

2577

bus = bus)

3262

2578

if server_settings["interface"]:

3263

2579

service.interface = if_nametoindex(

3264

2580

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

3265

2581

3266

2582

global multiprocessing_manager

3267

2583

multiprocessing_manager = multiprocessing.Manager()

3268

2584

3269

2585

client_class = Client

3270

2586

if use_dbus:

3271

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

3272

2587

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

2588

3273

2589

client_settings = Client.config_parser(client_config)

3274

2590

old_client_settings = {}

3275

2591

clients_data = {}

3276

2592

3277

2593

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

3278

2594

global wnull

3279

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

2595

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

3280

2596

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

3281

2597

# mode

3282

2598

if debug or not foreground:

3283

2599

wnull.close()

3284

2600

3285

2601

# Get client data and settings from last running state.

3286

2602

if server_settings["restore"]:

3287

2603

try:

3288

2604

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

3289

if sys.version_info.major == 2:

3290

clients_data, old_client_settings = pickle.load(

3291

stored_state)

3292

else:

3293

bytes_clients_data, bytes_old_client_settings = (

3294

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

3295

# Fix bytes to strings

3296

# clients_data

3297

# .keys()

3298

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

3299

if isinstance(key, bytes)

3300

else key): value

3301

for key, value in

3302

bytes_clients_data.items()}

3303

del bytes_clients_data

3304

for key in clients_data:

3305

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

3306

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

3307

for k, v in

3308

clients_data[key].items()}

3309

clients_data[key] = value

3310

# .client_structure

3311

value["client_structure"] = [

3312

(s.decode("utf-8")

3313

if isinstance(s, bytes)

3314

else s) for s in

3315

value["client_structure"]]

3316

# .name, .host, and .checker_command

3317

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

3318

if isinstance(value[k], bytes):

3319

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

3320

if "key_id" not in value:

3321

value["key_id"] = ""

3322

elif "fingerprint" not in value:

3323

value["fingerprint"] = ""

3324

# old_client_settings

3325

# .keys()

3326

old_client_settings = {

3327

(key.decode("utf-8")

3328

if isinstance(key, bytes)

3329

else key): value

3330

for key, value in

3331

bytes_old_client_settings.items()}

3332

del bytes_old_client_settings

3333

# .host and .checker_command

3334

for value in old_client_settings.values():

3335

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

3336

if isinstance(value[attribute], bytes):

3337

value[attribute] = (value[attribute]

3338

.decode("utf-8"))

2605

clients_data, old_client_settings = pickle.load(

2606

stored_state)

3339

2607

os.remove(stored_state_path)

3340

2608

except IOError as e:

3341

2609

if e.errno == errno.ENOENT:

3342

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

3343

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

2610

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

2611

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

3344

2612

else:

3345

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

3346

exc_info=e)

2613

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

2614

exc_info=e)

3347

2615

raise

3348

2616

except EOFError as e:

3349

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

3350

exc_info=e)

3351

2617

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

2618

"EOFError:",

2619

exc_info=e)

2620

3352

2621

with PGPEngine() as pgp:

3353

2622

for client_name, client in clients_data.items():

3354

2623

# Skip removed clients

3355

2624

if client_name not in client_settings:

3356

2625

continue

3357

2626

3358

2627

# Decide which value to use after restoring saved state.

3359

2628

# We have three different values: Old config file,

3360

2629

# new config file, and saved state.

3371

2640

client[name] = value

3372

2641

except KeyError:

3373

2642

pass

3374

2643

3375

2644

# Clients who has passed its expire date can still be

3376

2645

# enabled if its last checker was successful. A Client

3377

2646

# whose checker succeeded before we stored its state is

3380

2649

if client["enabled"]:

3381

2650

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

3382

2651

if not client["last_checked_ok"]:

3383

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

3384

" never performed a successful"

3385

" checker", client_name)

2652

logger.warning(

2653

"disabling client {} - Client never "

2654

"performed a successful checker".format(

2655

client_name))

3386

2656

client["enabled"] = False

3387

2657

elif client["last_checker_status"] != 0:

3388

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

3389

" last checker failed with error"

3390

" code %s", client_name,

3391

client["last_checker_status"])

2658

logger.warning(

2659

"disabling client {} - Client last"

2660

" checker failed with error code"

2661

" {}".format(

2662

client_name,

2663

client["last_checker_status"]))

3392

2664

client["enabled"] = False

3393

2665

else:

3394

2666

client["expires"] = (

3395

2667

datetime.datetime.utcnow()

3396

2668

+ client["timeout"])

3397

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

3398

" enabled", client_name)

2669

logger.debug("Last checker succeeded,"

2670

" keeping {} enabled".format(

2671

client_name))

3399

2672

try:

3400

2673

client["secret"] = pgp.decrypt(

3401

2674

client["encrypted_secret"],

3402

2675

client_settings[client_name]["secret"])

3403

2676

except PGPError:

3404

2677

# If decryption fails, we use secret from new settings

3405

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

3406

client_name)

2678

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

2679

client_name))

3407

2680

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

3408

2681

["secret"])

3409

2682

3410

2683

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

3411

2684

for client_name in (set(old_client_settings)

3412

2685

- set(client_settings)):

3414

2687

for client_name in (set(client_settings)

3415

2688

- set(old_client_settings)):

3416

2689

clients_data[client_name] = client_settings[client_name]

3417

2690

3418

2691

# Create all client objects

3419

2692

for client_name, client in clients_data.items():

3420

2693

tcp_server.clients[client_name] = client_class(

3421

name=client_name,

3422

settings=client,

3423

server_settings=server_settings)

3424

2694

name = client_name,

2695

settings = client,

2696

server_settings = server_settings)

2697

3425

2698

if not tcp_server.clients:

3426

log.warning("No clients defined")

3427

2699

logger.warning("No clients defined")

2700

3428

2701

if not foreground:

3429

2702

if pidfile is not None:

3430

pid = os.getpid()

3431

2703

try:

3432

2704

with pidfile:

3433

print(pid, file=pidfile)

2705

pid = os.getpid()

2706

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

3434

2707

except IOError:

3435

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

3436

pidfilename, pid)

2708

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

2709

pidfilename, pid)

3437

2710

del pidfile

3438

2711

del pidfilename

3439

3440

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

3441

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3442

lambda: main_loop.quit() and False)

3443

2712

2713

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

2714

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

2715

3444

2716

if use_dbus:

3445

2717

3446

2718

@alternate_dbus_interfaces(

3447

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

3448

class MandosDBusService(DBusObjectWithObjectManager):

2719

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

2720

class MandosDBusService(DBusObjectWithProperties):

3449

2721

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

3450

2722

3451

2723

def __init__(self):

3452

2724

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

3453

2725

3454

2726

_interface = "se.recompile.Mandos"

3455

2727

2728

@dbus_interface_annotations(_interface)

2729

def _foo(self):

2730

return {

2731

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

2732

"false" }

2733

3456

2734

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

3457

2735

def ClientAdded(self, objpath):

3458

2736

"D-Bus signal"

3459

2737

pass

3460

2738

3461

2739

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

3462

def ClientNotFound(self, key_id, address):

2740

def ClientNotFound(self, fingerprint, address):

3463

2741

"D-Bus signal"

3464

2742

pass

3465

3466

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

3467

"true"})

2743

3468

2744

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

3469

2745

def ClientRemoved(self, objpath, name):

3470

2746

"D-Bus signal"

3471

2747

pass

3472

3473

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

3474

"true"})

2748

3475

2749

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

3476

2750

def GetAllClients(self):

3477

2751

"D-Bus method"

3478

2752

return dbus.Array(c.dbus_object_path for c in

3479

tcp_server.clients.values())

3480

3481

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

3482

"true"})

2753

tcp_server.clients.itervalues())

2754

3483

2755

@dbus.service.method(_interface,

3484

2756

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

3485

2757

def GetAllClientsWithProperties(self):

3486

2758

"D-Bus method"

3487

2759

return dbus.Dictionary(

3488

{c.dbus_object_path: c.GetAll(

3489

"se.recompile.Mandos.Client")

3490

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

2760

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

2761

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

3491

2762

signature="oa{sv}")

3492

2763

3493

2764

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

3494

2765

def RemoveClient(self, object_path):

3495

2766

"D-Bus method"

3496

for c in tcp_server.clients.values():

2767

for c in tcp_server.clients.itervalues():

3497

2768

if c.dbus_object_path == object_path:

3498

2769

del tcp_server.clients[c.name]

3499

2770

c.remove_from_connection()

3500

# Don't signal the disabling

2771

# Don't signal anything except ClientRemoved

3501

2772

c.disable(quiet=True)

3502

# Emit D-Bus signal for removal

3503

self.client_removed_signal(c)

2773

# Emit D-Bus signal

2774

self.ClientRemoved(object_path, c.name)

3504

2775

return

3505

2776

raise KeyError(object_path)

3506

2777

3507

2778

del _interface

3508

3509

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3510

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

3511

def GetManagedObjects(self):

3512

"""D-Bus method"""

3513

return dbus.Dictionary(

3514

{client.dbus_object_path:

3515

dbus.Dictionary(

3516

{interface: client.GetAll(interface)

3517

for interface in

3518

client._get_all_interface_names()})

3519

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

3520

3521

def client_added_signal(self, client):

3522

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

3523

if use_dbus:

3524

# New standard signal

3525

self.InterfacesAdded(

3526

client.dbus_object_path,

3527

dbus.Dictionary(

3528

{interface: client.GetAll(interface)

3529

for interface in

3530

client._get_all_interface_names()}))

3531

# Old signal

3532

self.ClientAdded(client.dbus_object_path)

3533

3534

def client_removed_signal(self, client):

3535

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

3536

if use_dbus:

3537

# New standard signal

3538

self.InterfacesRemoved(

3539

client.dbus_object_path,

3540

client._get_all_interface_names())

3541

# Old signal

3542

self.ClientRemoved(client.dbus_object_path,

3543

client.name)

3544

2779

3545

2780

mandos_dbus_service = MandosDBusService()

3546

3547

# Save modules to variables to exempt the modules from being

3548

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

3549

mp = multiprocessing

3550

wn = wnull

3551

2781

3552

2782

def cleanup():

3553

2783

"Cleanup function; run on exit"

3554

2784

if zeroconf:

3555

2785

service.cleanup()

3556

3557

mp.active_children()

3558

wn.close()

2786

2787

multiprocessing.active_children()

2788

wnull.close()

3559

2789

if not (tcp_server.clients or client_settings):

3560

2790

return

3561

2791

3562

2792

# Store client before exiting. Secrets are encrypted with key

3563

2793

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

3564

2794

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

3565

2795

clients = {}

3566

2796

with PGPEngine() as pgp:

3567

for client in tcp_server.clients.values():

2797

for client in tcp_server.clients.itervalues():

3568

2798

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

3569

2799

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

3570

2800

key)

3571

2801

client_dict = {}

3572

2802

3573

2803

# A list of attributes that can not be pickled

3574

2804

# + secret.

3575

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

3576

"checker", "server_settings"}

2805

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

2806

"checker", "server_settings" }

3577

2807

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

3578

2808

.Object):

3579

2809

exclude.add(name)

3580

2810

3581

2811

client_dict["encrypted_secret"] = (client

3582

2812

.encrypted_secret)

3583

2813

for attr in client.client_structure:

3584

2814

if attr not in exclude:

3585

2815

client_dict[attr] = getattr(client, attr)

3586

2816

3587

2817

clients[client.name] = client_dict

3588

2818

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

3589

2819

3590

2820

try:

3591

2821

with tempfile.NamedTemporaryFile(

3592

mode="wb",

2822

mode='wb',

3593

2823

suffix=".pickle",

3594

prefix="clients-",

2824

prefix='clients-',

3595

2825

dir=os.path.dirname(stored_state_path),

3596

2826

delete=False) as stored_state:

3597

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

3598

protocol=2)

2827

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

3599

2828

tempname = stored_state.name

3600

2829

os.rename(tempname, stored_state_path)

3601

2830

except (IOError, OSError) as e:

3605

2834

except NameError:

3606

2835

pass

3607

2836

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

3608

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

3609

os.strerror(e.errno))

2837

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

2838

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

3610

2839

else:

3611

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

3612

exc_info=e)

2840

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

2841

exc_info=e)

3613

2842

raise

3614

2843

3615

2844

# Delete all clients, and settings from config

3616

2845

while tcp_server.clients:

3617

2846

name, client = tcp_server.clients.popitem()

3618

2847

if use_dbus:

3619

2848

client.remove_from_connection()

3620

# Don't signal the disabling

2849

# Don't signal anything except ClientRemoved

3621

2850

client.disable(quiet=True)

3622

# Emit D-Bus signal for removal

3623

2851

if use_dbus:

3624

mandos_dbus_service.client_removed_signal(client)

2852

# Emit D-Bus signal

2853

mandos_dbus_service.ClientRemoved(

2854

client.dbus_object_path, client.name)

3625

2855

client_settings.clear()

3626

2856

3627

2857

atexit.register(cleanup)

3628

3629

for client in tcp_server.clients.values():

2858

2859

for client in tcp_server.clients.itervalues():

3630

2860

if use_dbus:

3631

# Emit D-Bus signal for adding

3632

mandos_dbus_service.client_added_signal(client)

2861

# Emit D-Bus signal

2862

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3633

2863

# Need to initiate checking of clients

3634

2864

if client.enabled:

3635

client.init_checker(randomize_start=True)

3636

2865

client.init_checker()

2866

3637

2867

tcp_server.enable()

3638

2868

tcp_server.server_activate()

3639

2869

3640

2870

# Find out what port we got

3641

2871

if zeroconf:

3642

2872

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

3643

2873

if use_ipv6:

3644

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

3645

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

2874

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

2875

" flowinfo %d, scope_id %d",

2876

*tcp_server.socket.getsockname())

3646

2877

else: # IPv4

3647

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

3648

*tcp_server.socket.getsockname())

3649

3650

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

3651

2878

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

2879

*tcp_server.socket.getsockname())

2880

2881

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

2882

3652

2883

try:

3653

2884

if zeroconf:

3654

2885

# From the Avahi example code

3655

2886

try:

3656

2887

service.activate()

3657

2888

except dbus.exceptions.DBusException as error:

3658

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

2889

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

3659

2890

cleanup()

3660

2891

sys.exit(1)

3661

2892

# End of Avahi example code

3662

3663

GLib.io_add_watch(

3664

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

3665

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3666

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

3667

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

3668

3669

log.debug("Starting main loop")

2893

2894

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

2895

lambda *args, **kwargs:

2896

(tcp_server.handle_request

2897

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

2898

2899

logger.debug("Starting main loop")

3670

2900

main_loop.run()

3671

2901

except AvahiError as error:

3672

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

2902

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

3673

2903

cleanup()

3674

2904

sys.exit(1)

3675

2905

except KeyboardInterrupt:

3676

2906

if debug:

3677

2907

print("", file=sys.stderr)

3678

log.debug("Server received KeyboardInterrupt")

3679

log.debug("Server exiting")

2908

logger.debug("Server received KeyboardInterrupt")

2909

logger.debug("Server exiting")

3680

2910

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

3681

2911

cleanup()

3682

2912

3683

3684

def parse_test_args():

3685

# type: () -> argparse.Namespace

3686

parser = argparse.ArgumentParser(add_help=False)

3687

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

3688

parser.add_argument("--prefix", )

3689

args, unknown_args = parser.parse_known_args()

3690

if args.check:

3691

# Remove test options from sys.argv

3692

sys.argv[1:] = unknown_args

3693

return args

3694

3695

# Add all tests from doctest strings

3696

def load_tests(loader, tests, none):

3697

import doctest

3698

tests.addTests(doctest.DocTestSuite())

3699

return tests

3700

3701

if __name__ == "__main__":

3702

options = parse_test_args()

3703

try:

3704

if options.check:

3705

extra_test_prefix = options.prefix

3706

if extra_test_prefix is not None:

3707

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

3708

.result.wasSuccessful()):

3709

sys.exit(1)

3710

class ExtraTestLoader(unittest.TestLoader):

3711

testMethodPrefix = extra_test_prefix

3712

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

3713

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

3714

else:

3715

unittest.main(argv=[""])

3716

else:

3717

main()

3718

finally:

3719

logging.shutdown()

3720

3721

# Local Variables:

3722

# run-tests:

3723

# (lambda (&optional extra)

3724

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

3725

# extra))

3726

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

3727

# (funcall remove-test-window)

3728

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

3729

# run-tests-in-test-buffer:

3730

# (lambda (dir &optional extra)

3731

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

3732

# (setq buffer-read-only nil

3733

# default-directory dir)

3734

# (erase-buffer)

3735

# (compilation-mode))

3736

# (let ((process-result

3737

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

3738

# (process-file-shell-command

3739

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

3740

# (and (numberp process-result)

3741

# (= process-result 0))))

3742

# get-command-line:

3743

# (lambda (&optional extra)

3744

# (let ((quoted-script

3745

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

3746

# (format

3747

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

3748

# quoted-script)))

3749

# get-script-name:

3750

# (lambda ()

3751

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

3752

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

3753

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

3754

# (buffer-file-name))))

3755

# remove-test-window:

3756

# (lambda ()

3757

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

3758

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

3759

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

3760

# (lambda ()

3761

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

3762

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

3763

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

3764

# (display-buffer-overriding-action

3765

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

3766

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

3767

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

3768

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

3769

# eval:

3770

# (progn

3771

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

3772

# (funcall run-tests t)))

3773

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

3774

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

3775

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

3776

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

3777

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

3778

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

3779

# End:

2913

2914

if __name__ == '__main__':

2915

main()