/mandos/release : revision 237.7.127

1

#!/usr/bin/python3 -bI

2

# -*- mode: python; after-save-hook: (lambda () (let ((command (if (fboundp 'file-local-name) (file-local-name (buffer-file-name)) (or (file-remote-p (buffer-file-name) 'localname) (buffer-file-name))))) (if (= (progn (if (get-buffer "*Test*") (kill-buffer "*Test*")) (process-file-shell-command (format "%s --check" (shell-quote-argument command)) nil "*Test*")) 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w))) (progn (with-current-buffer "*Test*" (compilation-mode)) (display-buffer "*Test*" '(display-buffer-in-side-window)))))); coding: utf-8 -*-

3

#

1

#!/usr/bin/python

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

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

55

51

import sys

56

52

import re

57

53

import os

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

import collections

79

import codecs

80

import unittest

81

import random

82

import shlex

83

71

84

72

import dbus

85

73

import dbus.service

86

import gi

87

from gi.repository import GLib

74

import gobject

75

import avahi

88

76

from dbus.mainloop.glib import DBusGMainLoop

89

77

import ctypes

90

78

import ctypes.util

91

79

import xml.dom.minidom

92

80

import inspect

93

94

if sys.version_info.major == 2:

95

__metaclass__ = type

96

str = unicode

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:

81

import GnuPGInterface

82

83

try:

122

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

123

85

except AttributeError:

124

86

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

127

87

from IN import SO_BINDTODEVICE

128

88

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

89

SO_BINDTODEVICE = None

90

91

version = "1.5.3"

147

92

stored_state_file = "clients.pickle"

148

93

149

94

logger = logging.getLogger()

150

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

151

syslogger = None

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

address = str("/dev/log")))

152

98

153

99

try:

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

156

103

except (OSError, AttributeError):

157

158

104

def if_nametoindex(interface):

159

105

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

160

106

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

161

107

with contextlib.closing(socket.socket()) as s:

162

108

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

163

struct.pack(b"16s16x", interface))

164

interface_index = struct.unpack("I", ifreq[16:20])[0]

109

struct.pack(str("16s16x"),

110

interface))

111

interface_index = struct.unpack(str("I"),

112

ifreq[16:20])[0]

165

113

return interface_index

166

114

167

115

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

116

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

185

117

"""init logger and add loglevel"""

186

187

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

118

191

119

syslogger.setFormatter(logging.Formatter

192

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

193

" %(message)s"))

120

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

121

' %(message)s'))

194

122

logger.addHandler(syslogger)

195

123

196

124

if debug:

197

125

console = logging.StreamHandler()

198

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

199

" [%(process)d]:"

200

" %(levelname)s:"

201

" %(message)s"))

126

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

127

' [%(process)d]:'

128

' %(levelname)s:'

129

' %(message)s'))

202

130

logger.addHandler(console)

203

131

logger.setLevel(level)

204

132

208

136

pass

209

137

210

138

211

class PGPEngine:

139

class PGPEngine(object):

212

140

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

213

214

141

def __init__(self):

142

self.gnupg = GnuPGInterface.GnuPG()

215

143

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

144

self.gnupg = GnuPGInterface.GnuPG()

145

self.gnupg.options.meta_interactive = False

146

self.gnupg.options.homedir = self.tempdir

147

self.gnupg.options.extra_args.extend(['--force-mdc',

148

'--quiet',

149

'--no-use-agent'])

150

235

151

def __enter__(self):

236

152

return self

237

238

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

153

154

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

239

155

self._cleanup()

240

156

return False

241

157

242

158

def __del__(self):

243

159

self._cleanup()

244

160

245

161

def _cleanup(self):

246

162

if self.tempdir is not None:

247

163

# Delete contents of tempdir

248

164

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

249

topdown=False):

165

topdown = False):

250

166

for filename in files:

251

167

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

252

168

for dirname in dirs:

254

170

# Remove tempdir

255

171

os.rmdir(self.tempdir)

256

172

self.tempdir = None

257

173

258

174

def password_encode(self, password):

259

175

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

260

176

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

261

encoded = b"mandos" + binascii.hexlify(password)

262

if len(encoded) > 2048:

263

# GnuPG can't handle long passwords, so encode differently

264

encoded = (b"mandos" + password.replace(b"\\", b"\\\\")

265

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

266

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

267

return encoded

268

177

return b"mandos" + binascii.hexlify(password)

178

269

179

def encrypt(self, data, password):

270

passphrase = self.password_encode(password)

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

273

passfile.write(passphrase)

274

passfile.flush()

275

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

276

"--passphrase-file",

277

passfile.name]

278

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

283

if proc.returncode != 0:

284

raise PGPError(err)

180

self.gnupg.passphrase = self.password_encode(password)

181

with open(os.devnull, "w") as devnull:

182

try:

183

proc = self.gnupg.run(['--symmetric'],

184

create_fhs=['stdin', 'stdout'],

185

attach_fhs={'stderr': devnull})

186

with contextlib.closing(proc.handles['stdin']) as f:

187

f.write(data)

188

with contextlib.closing(proc.handles['stdout']) as f:

189

ciphertext = f.read()

190

proc.wait()

191

except IOError as e:

192

raise PGPError(e)

193

self.gnupg.passphrase = None

285

194

return ciphertext

286

195

287

196

def decrypt(self, data, password):

288

passphrase = self.password_encode(password)

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

291

passfile.write(passphrase)

292

passfile.flush()

293

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

294

"--passphrase-file",

295

passfile.name]

296

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

301

if proc.returncode != 0:

302

raise PGPError(err)

197

self.gnupg.passphrase = self.password_encode(password)

198

with open(os.devnull, "w") as devnull:

199

try:

200

proc = self.gnupg.run(['--decrypt'],

201

create_fhs=['stdin', 'stdout'],

202

attach_fhs={'stderr': devnull})

203

with contextlib.closing(proc.handles['stdin']) as f:

204

f.write(data)

205

with contextlib.closing(proc.handles['stdout']) as f:

206

decrypted_plaintext = f.read()

207

proc.wait()

208

except IOError as e:

209

raise PGPError(e)

210

self.gnupg.passphrase = None

303

211

return decrypted_plaintext

304

212

305

213

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

214

class AvahiError(Exception):

333

215

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

334

216

self.value = value

335

return super(AvahiError, self).__init__(value, *args,

336

**kwargs)

337

217

super(AvahiError, self).__init__(value, *args, **kwargs)

218

def __unicode__(self):

219

return unicode(repr(self.value))

338

220

339

221

class AvahiServiceError(AvahiError):

340

222

pass

341

223

342

343

224

class AvahiGroupError(AvahiError):

344

225

pass

345

226

346

227

347

class AvahiService:

228

class AvahiService(object):

348

229

"""An Avahi (Zeroconf) service.

349

230

350

231

Attributes:

351

232

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

352

233

Used to optionally bind to the specified interface.

353

354

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

355

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

234

235

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

236

See <http://www.dns-sd.org/ServiceTypes.html>

356

237

port: integer; what port to announce

357

238

TXT: list of strings; TXT record for the service

358

239

domain: string; Domain to publish on, default to .local if empty.

364

245

server: D-Bus Server

365

246

bus: dbus.SystemBus()

366

247

"""

367

368

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

248

249

def __init__(self, interface = avahi.IF_UNSPEC, name = None,

250

servicetype = None, port = None, TXT = None,

251

domain = "", host = "", max_renames = 32768,

252

protocol = avahi.PROTO_UNSPEC, bus = None):

379

253

self.interface = interface

380

254

self.name = name

381

255

self.type = servicetype

390

264

self.server = None

391

265

self.bus = bus

392

266

self.entry_group_state_changed_match = None

393

394

def rename(self, remove=True):

267

268

def rename(self):

395

269

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

396

270

if self.rename_count >= self.max_renames:

397

271

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

398

272

" after %i retries, exiting.",

399

273

self.rename_count)

400

274

raise AvahiServiceError("Too many renames")

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

403

self.rename_count += 1

275

self.name = unicode(self.server

276

.GetAlternativeServiceName(self.name))

404

277

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

405

278

self.name)

406

if remove:

407

self.remove()

279

self.remove()

408

280

try:

409

281

self.add()

410

282

except dbus.exceptions.DBusException as error:

411

if (error.get_dbus_name()

412

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

413

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

414

return self.rename(remove=False)

415

else:

416

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

417

self.cleanup()

418

os._exit(1)

419

283

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

284

self.cleanup()

285

os._exit(1)

286

self.rename_count += 1

287

420

288

def remove(self):

421

289

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

422

290

if self.entry_group_state_changed_match is not None:

424

292

self.entry_group_state_changed_match = None

425

293

if self.group is not None:

426

294

self.group.Reset()

427

295

428

296

def add(self):

429

297

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

430

298

self.remove()

435

303

avahi.DBUS_INTERFACE_ENTRY_GROUP)

436

304

self.entry_group_state_changed_match = (

437

305

self.group.connect_to_signal(

438

"StateChanged", self.entry_group_state_changed))

306

'StateChanged', self.entry_group_state_changed))

439

307

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

440

308

self.name, self.type)

441

309

self.group.AddService(

447

315

dbus.UInt16(self.port),

448

316

avahi.string_array_to_txt_array(self.TXT))

449

317

self.group.Commit()

450

318

451

319

def entry_group_state_changed(self, state, error):

452

320

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

453

321

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

454

322

455

323

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

324

logger.debug("Zeroconf service established.")

457

325

elif state == avahi.ENTRY_GROUP_COLLISION:

459

327

self.rename()

460

328

elif state == avahi.ENTRY_GROUP_FAILURE:

461

329

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

462

str(error))

463

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

464

330

unicode(error))

331

raise AvahiGroupError("State changed: {0!s}"

332

.format(error))

333

465

334

def cleanup(self):

466

335

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

467

336

if self.group is not None:

472

341

pass

473

342

self.group = None

474

343

self.remove()

475

344

476

345

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

477

346

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

478

347

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

479

bad_states = {

480

avahi.SERVER_INVALID: "Zeroconf server invalid",

481

avahi.SERVER_REGISTERING: None,

482

avahi.SERVER_COLLISION: "Zeroconf server name collision",

483

avahi.SERVER_FAILURE: "Zeroconf server failure",

484

}

348

bad_states = { avahi.SERVER_INVALID:

349

"Zeroconf server invalid",

350

avahi.SERVER_REGISTERING: None,

351

avahi.SERVER_COLLISION:

352

"Zeroconf server name collision",

353

avahi.SERVER_FAILURE:

354

"Zeroconf server failure" }

485

355

if state in bad_states:

486

356

if bad_states[state] is not None:

487

357

if error is None:

490

360

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

491

361

self.cleanup()

492

362

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

logger.info("Local Zeroconf service name"

499

" collision.")

500

return self.rename(remove=False)

501

else:

502

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

503

self.cleanup()

504

os._exit(1)

363

self.add()

505

364

else:

506

365

if error is None:

507

366

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

508

367

else:

509

368

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

510

369

511

370

def activate(self):

512

371

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

513

372

if self.server is None:

517

376

follow_name_owner_changes=True),

518

377

avahi.DBUS_INTERFACE_SERVER)

519

378

self.server.connect_to_signal("StateChanged",

520

self.server_state_changed)

379

self.server_state_changed)

521

380

self.server_state_changed(self.server.GetState())

522

381

523

524

382

class AvahiServiceToSyslog(AvahiService):

525

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

383

def rename(self):

526

384

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

527

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

528

**kwargs)

529

syslogger.setFormatter(logging.Formatter(

530

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

531

.format(self.name)))

385

ret = AvahiService.rename(self)

386

syslogger.setFormatter(logging.Formatter

387

('Mandos ({0}) [%(process)d]:'

388

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

389

.format(self.name)))

532

390

return ret

533

391

534

535

# Pretend that we have a GnuTLS module

536

class gnutls:

537

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

538

539

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

540

if library is None:

541

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

542

_library = ctypes.cdll.LoadLibrary(library)

543

del library

544

545

# Unless otherwise indicated, the constants and types below are

546

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

547

548

# Constants

549

E_SUCCESS = 0

550

E_INTERRUPTED = -52

551

E_AGAIN = -28

552

CRT_OPENPGP = 2

553

CRT_RAWPK = 3

554

CLIENT = 2

555

SHUT_RDWR = 0

556

CRD_CERTIFICATE = 1

557

E_NO_CERTIFICATE_FOUND = -49

558

X509_FMT_DER = 0

559

NO_TICKETS = 1<<10

560

ENABLE_RAWPK = 1<<18

561

CTYPE_PEERS = 3

562

KEYID_USE_SHA256 = 1 # gnutls/x509.h

563

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

564

565

# Types

566

class _session_int(ctypes.Structure):

567

_fields_ = []

568

session_t = ctypes.POINTER(_session_int)

569

570

class certificate_credentials_st(ctypes.Structure):

571

_fields_ = []

572

certificate_credentials_t = ctypes.POINTER(

573

certificate_credentials_st)

574

certificate_type_t = ctypes.c_int

575

576

class datum_t(ctypes.Structure):

577

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

578

("size", ctypes.c_uint)]

579

580

class _openpgp_crt_int(ctypes.Structure):

581

_fields_ = []

582

openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)

583

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

584

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

585

credentials_type_t = ctypes.c_int

586

transport_ptr_t = ctypes.c_void_p

587

close_request_t = ctypes.c_int

588

589

# Exceptions

590

class Error(Exception):

591

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

592

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

593

# code is passed, convert it to a string with

594

# gnutls.strerror()

595

self.code = code

596

if message is None and code is not None:

597

message = gnutls.strerror(code).decode(

598

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

599

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

600

message, *args)

601

602

class CertificateSecurityError(Error):

603

pass

604

605

class PointerTo:

606

def __init__(self, cls):

607

self.cls = cls

608

609

def from_param(self, obj):

610

if not isinstance(obj, self.cls):

611

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

612

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

613

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

614

615

class CastToVoidPointer:

616

def __init__(self, cls):

617

self.cls = cls

618

619

def from_param(self, obj):

620

if not isinstance(obj, self.cls):

621

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

622

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

623

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

624

625

class With_from_param:

626

@classmethod

627

def from_param(cls, obj):

628

return obj._as_parameter_

629

630

# Classes

631

class Credentials(With_from_param):

632

def __init__(self):

633

self._as_parameter_ = gnutls.certificate_credentials_t()

634

gnutls.certificate_allocate_credentials(self)

635

self.type = gnutls.CRD_CERTIFICATE

636

637

def __del__(self):

638

gnutls.certificate_free_credentials(self)

639

640

class ClientSession(With_from_param):

641

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

642

self._as_parameter_ = gnutls.session_t()

643

gnutls_flags = gnutls.CLIENT

644

if gnutls.check_version(b"3.5.6"):

645

gnutls_flags |= gnutls.NO_TICKETS

646

if gnutls.has_rawpk:

647

gnutls_flags |= gnutls.ENABLE_RAWPK

648

gnutls.init(self, gnutls_flags)

649

del gnutls_flags

650

gnutls.set_default_priority(self)

651

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

652

gnutls.handshake_set_private_extensions(self, True)

653

self.socket = socket

654

if credentials is None:

655

credentials = gnutls.Credentials()

656

gnutls.credentials_set(self, credentials.type,

657

credentials)

658

self.credentials = credentials

659

660

def __del__(self):

661

gnutls.deinit(self)

662

663

def handshake(self):

664

return gnutls.handshake(self)

665

666

def send(self, data):

667

data = bytes(data)

668

data_len = len(data)

669

while data_len > 0:

670

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

671

data_len)

672

673

def bye(self):

674

return gnutls.bye(self, gnutls.SHUT_RDWR)

675

676

# Error handling functions

677

def _error_code(result):

678

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

679

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

680

if result >= gnutls.E_SUCCESS:

681

return result

682

if result == gnutls.E_NO_CERTIFICATE_FOUND:

683

raise gnutls.CertificateSecurityError(code=result)

684

raise gnutls.Error(code=result)

685

686

def _retry_on_error(result, func, arguments,

687

_error_code=_error_code):

688

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

689

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

690

while result < gnutls.E_SUCCESS:

691

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

692

return _error_code(result)

693

result = func(*arguments)

694

return result

695

696

# Unless otherwise indicated, the function declarations below are

697

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

698

699

# Functions

700

priority_set_direct = _library.gnutls_priority_set_direct

701

priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,

702

ctypes.POINTER(ctypes.c_char_p)]

703

priority_set_direct.restype = _error_code

704

705

init = _library.gnutls_init

706

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

707

init.restype = _error_code

708

709

set_default_priority = _library.gnutls_set_default_priority

710

set_default_priority.argtypes = [ClientSession]

711

set_default_priority.restype = _error_code

712

713

record_send = _library.gnutls_record_send

714

record_send.argtypes = [ClientSession, ctypes.c_void_p,

715

ctypes.c_size_t]

716

record_send.restype = ctypes.c_ssize_t

717

record_send.errcheck = _retry_on_error

718

719

certificate_allocate_credentials = (

720

_library.gnutls_certificate_allocate_credentials)

721

certificate_allocate_credentials.argtypes = [

722

PointerTo(Credentials)]

723

certificate_allocate_credentials.restype = _error_code

724

725

certificate_free_credentials = (

726

_library.gnutls_certificate_free_credentials)

727

certificate_free_credentials.argtypes = [Credentials]

728

certificate_free_credentials.restype = None

729

730

handshake_set_private_extensions = (

731

_library.gnutls_handshake_set_private_extensions)

732

handshake_set_private_extensions.argtypes = [ClientSession,

733

ctypes.c_int]

734

handshake_set_private_extensions.restype = None

735

736

credentials_set = _library.gnutls_credentials_set

737

credentials_set.argtypes = [ClientSession, credentials_type_t,

738

CastToVoidPointer(Credentials)]

739

credentials_set.restype = _error_code

740

741

strerror = _library.gnutls_strerror

742

strerror.argtypes = [ctypes.c_int]

743

strerror.restype = ctypes.c_char_p

744

745

certificate_type_get = _library.gnutls_certificate_type_get

746

certificate_type_get.argtypes = [ClientSession]

747

certificate_type_get.restype = _error_code

748

749

certificate_get_peers = _library.gnutls_certificate_get_peers

750

certificate_get_peers.argtypes = [ClientSession,

751

ctypes.POINTER(ctypes.c_uint)]

752

certificate_get_peers.restype = ctypes.POINTER(datum_t)

753

754

global_set_log_level = _library.gnutls_global_set_log_level

755

global_set_log_level.argtypes = [ctypes.c_int]

756

global_set_log_level.restype = None

757

758

global_set_log_function = _library.gnutls_global_set_log_function

759

global_set_log_function.argtypes = [log_func]

760

global_set_log_function.restype = None

761

762

deinit = _library.gnutls_deinit

763

deinit.argtypes = [ClientSession]

764

deinit.restype = None

765

766

handshake = _library.gnutls_handshake

767

handshake.argtypes = [ClientSession]

768

handshake.restype = ctypes.c_int

769

handshake.errcheck = _retry_on_error

770

771

transport_set_ptr = _library.gnutls_transport_set_ptr

772

transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]

773

transport_set_ptr.restype = None

774

775

bye = _library.gnutls_bye

776

bye.argtypes = [ClientSession, close_request_t]

777

bye.restype = ctypes.c_int

778

bye.errcheck = _retry_on_error

779

780

check_version = _library.gnutls_check_version

781

check_version.argtypes = [ctypes.c_char_p]

782

check_version.restype = ctypes.c_char_p

783

784

_need_version = b"3.3.0"

785

if check_version(_need_version) is None:

786

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

787

.format(_need_version))

788

789

_tls_rawpk_version = b"3.6.6"

790

has_rawpk = bool(check_version(_tls_rawpk_version))

791

792

if has_rawpk:

793

# Types

794

class pubkey_st(ctypes.Structure):

795

_fields = []

796

pubkey_t = ctypes.POINTER(pubkey_st)

797

798

x509_crt_fmt_t = ctypes.c_int

799

800

# All the function declarations below are from

801

# gnutls/abstract.h

802

pubkey_init = _library.gnutls_pubkey_init

803

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

804

pubkey_init.restype = _error_code

805

806

pubkey_import = _library.gnutls_pubkey_import

807

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

808

x509_crt_fmt_t]

809

pubkey_import.restype = _error_code

810

811

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

812

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

813

ctypes.POINTER(ctypes.c_ubyte),

814

ctypes.POINTER(ctypes.c_size_t)]

815

pubkey_get_key_id.restype = _error_code

816

817

pubkey_deinit = _library.gnutls_pubkey_deinit

818

pubkey_deinit.argtypes = [pubkey_t]

819

pubkey_deinit.restype = None

820

else:

821

# All the function declarations below are from

822

# gnutls/openpgp.h

823

824

openpgp_crt_init = _library.gnutls_openpgp_crt_init

825

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

826

openpgp_crt_init.restype = _error_code

827

828

openpgp_crt_import = _library.gnutls_openpgp_crt_import

829

openpgp_crt_import.argtypes = [openpgp_crt_t,

830

ctypes.POINTER(datum_t),

831

openpgp_crt_fmt_t]

832

openpgp_crt_import.restype = _error_code

833

834

openpgp_crt_verify_self = \

835

_library.gnutls_openpgp_crt_verify_self

836

openpgp_crt_verify_self.argtypes = [

837

openpgp_crt_t,

838

ctypes.c_uint,

839

ctypes.POINTER(ctypes.c_uint),

840

]

841

openpgp_crt_verify_self.restype = _error_code

842

843

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

844

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

845

openpgp_crt_deinit.restype = None

846

847

openpgp_crt_get_fingerprint = (

848

_library.gnutls_openpgp_crt_get_fingerprint)

849

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

850

ctypes.c_void_p,

851

ctypes.POINTER(

852

ctypes.c_size_t)]

853

openpgp_crt_get_fingerprint.restype = _error_code

854

855

if check_version(b"3.6.4"):

856

certificate_type_get2 = _library.gnutls_certificate_type_get2

857

certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]

858

certificate_type_get2.restype = _error_code

859

860

# Remove non-public functions

861

del _error_code, _retry_on_error

862

863

864

def call_pipe(connection, # : multiprocessing.Connection

865

func, *args, **kwargs):

866

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

867

868

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

869

return value on the provided multiprocessing.Connection.

870

"""

871

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

872

connection.close()

873

874

875

class Client:

392

def timedelta_to_milliseconds(td):

393

"Convert a datetime.timedelta() to milliseconds"

394

return ((td.days * 24 * 60 * 60 * 1000)

395

+ (td.seconds * 1000)

396

+ (td.microseconds // 1000))

397

398

class Client(object):

876

399

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

877

400

878

401

Attributes:

879

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

402

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

880

403

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

881

404

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

882

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

883

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

884

running.

885

checker_callback_tag: a GLib event source tag, or None

405

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

406

to see if the client lives.

407

'None' if no process is running.

408

checker_callback_tag: a gobject event source tag, or None

886

409

checker_command: string; External command which is run to check

887

410

if client lives. %() expansions are done at

888

411

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

889

412

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

890

checker_initiator_tag: a GLib event source tag, or None

413

checker_initiator_tag: a gobject event source tag, or None

891

414

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

892

415

client_structure: Object describing what attributes a client has

893

416

and is used for storing the client at exit

894

417

current_checker_command: string; current running checker_command

895

disable_initiator_tag: a GLib event source tag, or None

418

disable_initiator_tag: a gobject event source tag, or None

896

419

enabled: bool()

897

420

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

898

uniquely identify an OpenPGP client

899

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

900

a client using raw public keys

421

uniquely identify the client

901

422

host: string; available for use by the checker command

902

423

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

903

424

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

905

426

last_checker_status: integer between 0 and 255 reflecting exit

906

427

status of last checker. -1 reflects crashed

907

428

checker, -2 means no checker completed yet.

908

last_checker_signal: The signal which killed the last checker, if

909

last_checker_status is -1

910

429

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

911

430

912

431

D-Bus identifiers

917

436

runtime_expansions: Allowed attributes for runtime expansion.

918

437

expires: datetime.datetime(); time (UTC) when a client will be

919

438

disabled, or None

920

server_settings: The server_settings dict from main()

921

439

"""

922

440

923

441

runtime_expansions = ("approval_delay", "approval_duration",

924

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

925

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

926

"last_approval_request", "last_checked_ok",

442

"created", "enabled", "fingerprint",

443

"host", "interval", "last_checked_ok",

927

444

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

928

client_defaults = {

929

"timeout": "PT5M",

930

"extended_timeout": "PT15M",

931

"interval": "PT2M",

932

"checker": "fping -q -- %%(host)s",

933

"host": "",

934

"approval_delay": "PT0S",

935

"approval_duration": "PT1S",

936

"approved_by_default": "True",

937

"enabled": "True",

938

}

939

445

client_defaults = { "timeout": "5m",

446

"extended_timeout": "15m",

447

"interval": "2m",

448

"checker": "fping -q -- %%(host)s",

449

"host": "",

450

"approval_delay": "0s",

451

"approval_duration": "1s",

452

"approved_by_default": "True",

453

"enabled": "True",

454

}

455

456

def timeout_milliseconds(self):

457

"Return the 'timeout' attribute in milliseconds"

458

return timedelta_to_milliseconds(self.timeout)

459

460

def extended_timeout_milliseconds(self):

461

"Return the 'extended_timeout' attribute in milliseconds"

462

return timedelta_to_milliseconds(self.extended_timeout)

463

464

def interval_milliseconds(self):

465

"Return the 'interval' attribute in milliseconds"

466

return timedelta_to_milliseconds(self.interval)

467

468

def approval_delay_milliseconds(self):

469

return timedelta_to_milliseconds(self.approval_delay)

470

940

471

@staticmethod

941

472

def config_parser(config):

942

473

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

949

480

for client_name in config.sections():

950

481

section = dict(config.items(client_name))

951

482

client = settings[client_name] = {}

952

483

953

484

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

954

485

# Reformat values from string types to Python types

955

486

client["approved_by_default"] = config.getboolean(

956

487

client_name, "approved_by_default")

957

488

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

958

489

"enabled")

959

960

# Uppercase and remove spaces from key_id and fingerprint

961

# for later comparison purposes with return value from the

962

# key_id() and fingerprint() functions

963

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

964

.replace(" ", ""))

490

965

491

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

966

492

.replace(" ", ""))

967

493

if "secret" in section:

968

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

969

.encode("utf-8"),

970

"base64")

494

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

971

495

elif "secfile" in section:

972

496

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

973

497

(section["secfile"])),

974

498

"rb") as secfile:

975

499

client["secret"] = secfile.read()

976

500

else:

977

raise TypeError("No secret or secfile for section {}"

501

raise TypeError("No secret or secfile for section {0}"

978

502

.format(section))

979

503

client["timeout"] = string_to_delta(section["timeout"])

980

504

client["extended_timeout"] = string_to_delta(

988

512

client["last_approval_request"] = None

989

513

client["last_checked_ok"] = None

990

514

client["last_checker_status"] = -2

991

515

992

516

return settings

993

994

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

517

518

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

995

519

self.name = name

996

if server_settings is None:

997

server_settings = {}

998

self.server_settings = server_settings

999

520

# adding all client settings

1000

for setting, value in settings.items():

521

for setting, value in settings.iteritems():

1001

522

setattr(self, setting, value)

1002

523

1003

524

if self.enabled:

1004

525

if not hasattr(self, "last_enabled"):

1005

526

self.last_enabled = datetime.datetime.utcnow()

1009

530

else:

1010

531

self.last_enabled = None

1011

532

self.expires = None

1012

533

1013

534

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

1014

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

535

# Uppercase and remove spaces from fingerprint for later

536

# comparison purposes with return value from the fingerprint()

537

# function

1015

538

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

1016

539

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

1017

540

datetime.datetime.utcnow())

1018

541

1019

542

# attributes specific for this server instance

1020

543

self.checker = None

1021

544

self.checker_initiator_tag = None

1024

547

self.current_checker_command = None

1025

548

self.approved = None

1026

549

self.approvals_pending = 0

1027

self.changedstate = multiprocessing_manager.Condition(

1028

multiprocessing_manager.Lock())

1029

self.client_structure = [attr

1030

for attr in self.__dict__.keys()

550

self.changedstate = (multiprocessing_manager

551

.Condition(multiprocessing_manager

552

.Lock()))

553

self.client_structure = [attr for attr in

554

self.__dict__.iterkeys()

1031

555

if not attr.startswith("_")]

1032

556

self.client_structure.append("client_structure")

1033

1034

for name, t in inspect.getmembers(

1035

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

557

558

for name, t in inspect.getmembers(type(self),

559

lambda obj:

560

isinstance(obj,

561

property)):

1036

562

if not name.startswith("_"):

1037

563

self.client_structure.append(name)

1038

564

1039

565

# Send notice to process children that client state has changed

1040

566

def send_changedstate(self):

1041

567

with self.changedstate:

1042

568

self.changedstate.notify_all()

1043

569

1044

570

def enable(self):

1045

571

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

1046

572

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

1047

573

# Already enabled

1048

574

return

575

self.send_changedstate()

1049

576

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

1050

577

self.enabled = True

1051

578

self.last_enabled = datetime.datetime.utcnow()

1052

579

self.init_checker()

1053

self.send_changedstate()

1054

580

1055

581

def disable(self, quiet=True):

1056

582

"""Disable this client."""

1057

583

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

1058

584

return False

1059

585

if not quiet:

586

self.send_changedstate()

587

if not quiet:

1060

588

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

1061

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

1062

GLib.source_remove(self.disable_initiator_tag)

589

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

590

gobject.source_remove(self.disable_initiator_tag)

1063

591

self.disable_initiator_tag = None

1064

592

self.expires = None

1065

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

1066

GLib.source_remove(self.checker_initiator_tag)

593

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

594

gobject.source_remove(self.checker_initiator_tag)

1067

595

self.checker_initiator_tag = None

1068

596

self.stop_checker()

1069

597

self.enabled = False

1070

if not quiet:

1071

self.send_changedstate()

1072

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

598

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

1073

599

return False

1074

600

1075

601

def __del__(self):

1076

602

self.disable()

1077

603

1078

604

def init_checker(self):

1079

605

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

1080

606

# and every interval from then on.

1081

if self.checker_initiator_tag is not None:

1082

GLib.source_remove(self.checker_initiator_tag)

1083

self.checker_initiator_tag = GLib.timeout_add(

1084

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

1085

+ 1)),

1086

self.start_checker)

607

self.checker_initiator_tag = (gobject.timeout_add

608

(self.interval_milliseconds(),

609

self.start_checker))

1087

610

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

1088

if self.disable_initiator_tag is not None:

1089

GLib.source_remove(self.disable_initiator_tag)

1090

self.disable_initiator_tag = GLib.timeout_add(

1091

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

611

self.disable_initiator_tag = (gobject.timeout_add

612

(self.timeout_milliseconds(),

613

self.disable))

1092

614

# Also start a new checker *right now*.

1093

615

self.start_checker()

1094

1095

def checker_callback(self, source, condition, connection,

1096

command):

616

617

def checker_callback(self, pid, condition, command):

1097

618

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

1098

# Read return code from connection (see call_pipe)

1099

returncode = connection.recv()

1100

connection.close()

1101

if self.checker is not None:

1102

self.checker.join()

1103

619

self.checker_callback_tag = None

1104

620

self.checker = None

1105

1106

if returncode >= 0:

1107

self.last_checker_status = returncode

1108

self.last_checker_signal = None

621

if os.WIFEXITED(condition):

622

self.last_checker_status = os.WEXITSTATUS(condition)

1109

623

if self.last_checker_status == 0:

1110

624

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

1111

625

vars(self))

1112

626

self.checked_ok()

1113

627

else:

1114

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

628

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

629

vars(self))

1115

630

else:

1116

631

self.last_checker_status = -1

1117

self.last_checker_signal = -returncode

1118

632

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

1119

633

vars(self))

1120

return False

1121

634

1122

635

def checked_ok(self):

1123

636

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

1124

637

self.last_checked_ok = datetime.datetime.utcnow()

1125

638

self.last_checker_status = 0

1126

self.last_checker_signal = None

1127

639

self.bump_timeout()

1128

640

1129

641

def bump_timeout(self, timeout=None):

1130

642

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

1131

643

if timeout is None:

1132

644

timeout = self.timeout

1133

645

if self.disable_initiator_tag is not None:

1134

GLib.source_remove(self.disable_initiator_tag)

1135

self.disable_initiator_tag = None

646

gobject.source_remove(self.disable_initiator_tag)

1136

647

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

1137

self.disable_initiator_tag = GLib.timeout_add(

1138

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

648

self.disable_initiator_tag = (gobject.timeout_add

649

(timedelta_to_milliseconds

650

(timeout), self.disable))

1139

651

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

1140

652

1141

653

def need_approval(self):

1142

654

self.last_approval_request = datetime.datetime.utcnow()

1143

655

1144

656

def start_checker(self):

1145

657

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

1146

658

1147

659

If a checker already exists, leave it running and do

1148

660

nothing."""

1149

661

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

1154

666

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

1155

667

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

1156

668

# should be.

1157

1158

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

1159

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

1160

self.checker.join()

1161

self.checker = None

669

670

# If a checker exists, make sure it is not a zombie

671

try:

672

pid, status = os.waitpid(self.checker.pid, os.WNOHANG)

673

except (AttributeError, OSError) as error:

674

if (isinstance(error, OSError)

675

and error.errno != errno.ECHILD):

676

raise error

677

else:

678

if pid:

679

logger.warning("Checker was a zombie")

680

gobject.source_remove(self.checker_callback_tag)

681

self.checker_callback(pid, status,

682

self.current_checker_command)

1162

683

# Start a new checker if needed

1163

684

if self.checker is None:

1164

# Escape attributes for the shell

1165

escaped_attrs = {

1166

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

1167

for attr in self.runtime_expansions}

1168

try:

1169

command = self.checker_command % escaped_attrs

1170

except TypeError as error:

1171

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

1172

self.checker_command,

685

try:

686

# In case checker_command has exactly one % operator

687

command = self.checker_command % self.host

688

except TypeError:

689

# Escape attributes for the shell

690

escaped_attrs = dict(

691

(attr,

692

re.escape(unicode(str(getattr(self, attr, "")),

693

errors=

694

'replace')))

695

for attr in

696

self.runtime_expansions)

697

698

try:

699

command = self.checker_command % escaped_attrs

700

except TypeError as error:

701

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

702

self.checker_command, exc_info=error)

703

return True # Try again later

704

self.current_checker_command = command

705

try:

706

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

707

command, self.name)

708

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

709

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

710

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

711

# always replaced by /dev/null.)

712

self.checker = subprocess.Popen(command,

713

close_fds=True,

714

shell=True, cwd="/")

715

self.checker_callback_tag = (gobject.child_watch_add

716

(self.checker.pid,

717

self.checker_callback,

718

data=command))

719

# The checker may have completed before the gobject

720

# watch was added. Check for this.

721

pid, status = os.waitpid(self.checker.pid, os.WNOHANG)

722

if pid:

723

gobject.source_remove(self.checker_callback_tag)

724

self.checker_callback(pid, status, command)

725

except OSError as error:

726

logger.error("Failed to start subprocess",

1173

727

exc_info=error)

1174

return True # Try again later

1175

self.current_checker_command = command

1176

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

1177

self.name)

1178

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

1179

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

1180

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

1181

# always replaced by /dev/null.)

1182

# The exception is when not debugging but nevertheless

1183

# running in the foreground; use the previously

1184

# created wnull.

1185

popen_args = {"close_fds": True,

1186

"shell": True,

1187

"cwd": "/"}

1188

if (not self.server_settings["debug"]

1189

and self.server_settings["foreground"]):

1190

popen_args.update({"stdout": wnull,

1191

"stderr": wnull})

1192

pipe = multiprocessing.Pipe(duplex=False)

1193

self.checker = multiprocessing.Process(

1194

target=call_pipe,

1195

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

1196

kwargs=popen_args)

1197

self.checker.start()

1198

self.checker_callback_tag = GLib.io_add_watch(

1199

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

1200

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1201

self.checker_callback, pipe[0], command)

1202

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

728

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

1203

729

return True

1204

730

1205

731

def stop_checker(self):

1206

732

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

1207

733

if self.checker_callback_tag:

1208

GLib.source_remove(self.checker_callback_tag)

734

gobject.source_remove(self.checker_callback_tag)

1209

735

self.checker_callback_tag = None

1210

736

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

1211

737

return

1212

738

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

1213

self.checker.terminate()

739

try:

740

self.checker.terminate()

741

#time.sleep(0.5)

742

#if self.checker.poll() is None:

743

# self.checker.kill()

744

except OSError as error:

745

if error.errno != errno.ESRCH: # No such process

746

raise

1214

747

self.checker = None

1215

748

1216

749

1217

def dbus_service_property(dbus_interface,

1218

signature="v",

1219

access="readwrite",

1220

byte_arrays=False):

750

def dbus_service_property(dbus_interface, signature="v",

751

access="readwrite", byte_arrays=False):

1221

752

"""Decorators for marking methods of a DBusObjectWithProperties to

1222

753

become properties on the D-Bus.

1223

754

1224

755

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

1225

756

and with one argument by "Set".

1226

757

1227

758

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

1228

759

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

1229

760

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

1232

763

# "Set" method, so we fail early here:

1233

764

if byte_arrays and signature != "ay":

1234

765

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

1235

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

1236

766

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

1237

767

def decorator(func):

1238

768

func._dbus_is_property = True

1239

769

func._dbus_interface = dbus_interface

1242

772

func._dbus_name = func.__name__

1243

773

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

1244

774

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

1245

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

775

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1246

776

return func

1247

1248

777

return decorator

1249

778

1250

779

1251

780

def dbus_interface_annotations(dbus_interface):

1252

781

"""Decorator for marking functions returning interface annotations

1253

782

1254

783

Usage:

1255

784

1256

785

@dbus_interface_annotations("org.example.Interface")

1257

786

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

1258

787

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

1259

788

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

1260

789

"false"}

1261

790

"""

1262

1263

791

def decorator(func):

1264

792

func._dbus_is_interface = True

1265

793

func._dbus_interface = dbus_interface

1266

794

func._dbus_name = dbus_interface

1267

795

return func

1268

1269

796

return decorator

1270

797

1271

798

1272

799

def dbus_annotations(annotations):

1273

800

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

1274

801

Usage:

1275

1276

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

1277

"org.freedesktop.DBus.Property."

1278

"EmitsChangedSignal": "false"})

802

1279

803

@dbus_service_property("org.example.Interface", signature="b",

1280

804

access="r")

805

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

806

"org.freedesktop.DBus.Property."

807

"EmitsChangedSignal": "false"})

1281

808

def Property_dbus_property(self):

1282

809

return dbus.Boolean(False)

1283

1284

See also the DBusObjectWithAnnotations class.

1285

810

"""

1286

1287

811

def decorator(func):

1288

812

func._dbus_annotations = annotations

1289

813

return func

1290

1291

814

return decorator

1292

815

1293

816

1294

817

class DBusPropertyException(dbus.exceptions.DBusException):

1295

818

"""A base class for D-Bus property-related exceptions

1296

819

"""

1297

pass

820

def __unicode__(self):

821

return unicode(str(self))

1298

822

1299

823

1300

824

class DBusPropertyAccessException(DBusPropertyException):

1309

833

pass

1310

834

1311

835

1312

class DBusObjectWithAnnotations(dbus.service.Object):

1313

"""A D-Bus object with annotations.

1314

1315

Classes inheriting from this can use the dbus_annotations

1316

decorator to add annotations to methods or signals.

836

class DBusObjectWithProperties(dbus.service.Object):

837

"""A D-Bus object with properties.

838

839

Classes inheriting from this can use the dbus_service_property

840

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

841

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

1317

842

"""

1318

843

1319

844

@staticmethod

1320

845

def _is_dbus_thing(thing):

1321

846

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

1322

847

1323

848

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

1324

849

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

1325

850

"""

1326

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

851

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

1327

852

False)

1328

853

1329

854

def _get_all_dbus_things(self, thing):

1330

855

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

1331

856

"""

1332

return ((getattr(athing.__get__(self), "_dbus_name", name),

857

return ((getattr(athing.__get__(self), "_dbus_name",

858

name),

1333

859

athing.__get__(self))

1334

860

for cls in self.__class__.__mro__

1335

861

for name, athing in

1336

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

1337

1338

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1339

out_signature="s",

1340

path_keyword="object_path",

1341

connection_keyword="connection")

1342

def Introspect(self, object_path, connection):

1343

"""Overloading of standard D-Bus method.

1344

1345

Inserts annotation tags on methods and signals.

1346

"""

1347

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

1348

connection)

1349

try:

1350

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

1351

1352

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

1353

# Add annotation tags

1354

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

1355

for tag in if_tag.getElementsByTagName(typ):

1356

annots = dict()

1357

for name, prop in (self.

1358

_get_all_dbus_things(typ)):

1359

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

1360

and prop._dbus_interface

1361

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

1362

annots.update(getattr(

1363

prop, "_dbus_annotations", {}))

1364

for name, value in annots.items():

1365

ann_tag = document.createElement(

1366

"annotation")

1367

ann_tag.setAttribute("name", name)

1368

ann_tag.setAttribute("value", value)

1369

tag.appendChild(ann_tag)

1370

# Add interface annotation tags

1371

for annotation, value in dict(

1372

itertools.chain.from_iterable(

1373

annotations().items()

1374

for name, annotations

1375

in self._get_all_dbus_things("interface")

1376

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

1377

)).items():

1378

ann_tag = document.createElement("annotation")

1379

ann_tag.setAttribute("name", annotation)

1380

ann_tag.setAttribute("value", value)

1381

if_tag.appendChild(ann_tag)

1382

# Fix argument name for the Introspect method itself

1383

if (if_tag.getAttribute("name")

1384

== dbus.INTROSPECTABLE_IFACE):

1385

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

1386

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

1387

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

1388

if (arg.getAttribute("direction")

1389

== "out"):

1390

arg.setAttribute("name",

1391

"xml_data")

1392

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

1393

document.unlink()

1394

except (AttributeError, xml.dom.DOMException,

1395

xml.parsers.expat.ExpatError) as error:

1396

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

1397

exc_info=error)

1398

return xmlstring

1399

1400

1401

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1402

"""A D-Bus object with properties.

1403

1404

Classes inheriting from this can use the dbus_service_property

1405

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

1406

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

1407

"""

1408

862

inspect.getmembers(cls,

863

self._is_dbus_thing(thing)))

864

1409

865

def _get_dbus_property(self, interface_name, property_name):

1410

866

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

1411

867

property with the specified name and interface.

1412

868

"""

1413

for cls in self.__class__.__mro__:

1414

for name, value in inspect.getmembers(

1415

cls, self._is_dbus_thing("property")):

869

for cls in self.__class__.__mro__:

870

for name, value in (inspect.getmembers

871

(cls,

872

self._is_dbus_thing("property"))):

1416

873

if (value._dbus_name == property_name

1417

874

and value._dbus_interface == interface_name):

1418

875

return value.__get__(self)

1419

876

1420

877

# No such property

1421

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

1422

self.dbus_object_path, interface_name, property_name))

1423

1424

@classmethod

1425

def _get_all_interface_names(cls):

1426

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

1427

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

1428

"_dbus_interface", None)

1429

for x in (inspect.getmro(cls))

1430

for attr in dir(x))

1431

if name is not None)

1432

1433

@dbus.service.method(dbus.PROPERTIES_IFACE,

1434

in_signature="ss",

878

raise DBusPropertyNotFound(self.dbus_object_path + ":"

879

+ interface_name + "."

880

+ property_name)

881

882

@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",

1435

883

out_signature="v")

1436

884

def Get(self, interface_name, property_name):

1437

885

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

1443

891

if not hasattr(value, "variant_level"):

1444

892

return value

1445

893

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

1446

894

1447

895

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

1448

896

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

1449

897

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

1455

903

# The byte_arrays option is not supported yet on

1456

904

# signatures other than "ay".

1457

905

if prop._dbus_signature != "ay":

1458

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

1459

"'ay' signature {!r}"

1460

.format(prop._dbus_signature))

1461

value = dbus.ByteArray(bytes(value))

906

raise ValueError

907

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

908

for byte in value))

1462

909

prop(value)

1463

1464

@dbus.service.method(dbus.PROPERTIES_IFACE,

1465

in_signature="s",

910

911

@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",

1466

912

out_signature="a{sv}")

1467

913

def GetAll(self, interface_name):

1468

914

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

1469

915

standard.

1470

916

1471

917

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

1472

918

"""

1473

919

properties = {}

1483

929

if not hasattr(value, "variant_level"):

1484

930

properties[name] = value

1485

931

continue

1486

properties[name] = type(value)(

1487

value, variant_level=value.variant_level + 1)

932

properties[name] = type(value)(value, variant_level=

933

value.variant_level+1)

1488

934

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

1489

1490

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

1491

def PropertiesChanged(self, interface_name, changed_properties,

1492

invalidated_properties):

1493

"""Standard D-Bus PropertiesChanged() signal, see D-Bus

1494

standard.

1495

"""

1496

pass

1497

935

1498

936

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1499

937

out_signature="s",

1500

path_keyword="object_path",

1501

connection_keyword="connection")

938

path_keyword='object_path',

939

connection_keyword='connection')

1502

940

def Introspect(self, object_path, connection):

1503

941

"""Overloading of standard D-Bus method.

1504

942

1505

943

Inserts property tags and interface annotation tags.

1506

944

"""

1507

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1508

object_path,

1509

connection)

945

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

946

connection)

1510

947

try:

1511

948

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

1512

1513

949

def make_tag(document, name, prop):

1514

950

e = document.createElement("property")

1515

951

e.setAttribute("name", name)

1516

952

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

1517

953

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

1518

954

return e

1519

1520

955

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

1521

956

# Add property tags

1522

957

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

1525

960

if prop._dbus_interface

1526

961

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

1527

962

if_tag.appendChild(tag)

1528

# Add annotation tags for properties

1529

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

1530

annots = dict()

1531

for name, prop in self._get_all_dbus_things(

1532

"property"):

1533

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

1534

and prop._dbus_interface

1535

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

1536

annots.update(getattr(

1537

prop, "_dbus_annotations", {}))

1538

for name, value in annots.items():

1539

ann_tag = document.createElement(

1540

"annotation")

1541

ann_tag.setAttribute("name", name)

1542

ann_tag.setAttribute("value", value)

1543

tag.appendChild(ann_tag)

963

# Add annotation tags

964

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

965

for tag in if_tag.getElementsByTagName(typ):

966

annots = dict()

967

for name, prop in (self.

968

_get_all_dbus_things(typ)):

969

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

970

and prop._dbus_interface

971

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

972

annots.update(getattr

973

(prop,

974

"_dbus_annotations",

975

{}))

976

for name, value in annots.iteritems():

977

ann_tag = document.createElement(

978

"annotation")

979

ann_tag.setAttribute("name", name)

980

ann_tag.setAttribute("value", value)

981

tag.appendChild(ann_tag)

982

# Add interface annotation tags

983

for annotation, value in dict(

984

itertools.chain.from_iterable(

985

annotations().iteritems()

986

for name, annotations in

987

self._get_all_dbus_things("interface")

988

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

989

)).iteritems():

990

ann_tag = document.createElement("annotation")

991

ann_tag.setAttribute("name", annotation)

992

ann_tag.setAttribute("value", value)

993

if_tag.appendChild(ann_tag)

1544

994

# Add the names to the return values for the

1545

995

# "org.freedesktop.DBus.Properties" methods

1546

996

if (if_tag.getAttribute("name")

1565

1015

return xmlstring

1566

1016

1567

1017

1568

try:

1569

dbus.OBJECT_MANAGER_IFACE

1570

except AttributeError:

1571

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

1572

1573

1574

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1575

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

1576

1577

Classes inheriting from this exposes the standard

1578

GetManagedObjects call and the InterfacesAdded and

1579

InterfacesRemoved signals on the standard

1580

"org.freedesktop.DBus.ObjectManager" interface.

1581

1582

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

1583

manually.

1584

"""

1585

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1586

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

1587

def GetManagedObjects(self):

1588

"""This function must be overridden"""

1589

raise NotImplementedError()

1590

1591

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1592

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

1593

def InterfacesAdded(self, object_path, interfaces_and_properties):

1594

pass

1595

1596

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

1597

def InterfacesRemoved(self, object_path, interfaces):

1598

pass

1599

1600

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1601

out_signature="s",

1602

path_keyword="object_path",

1603

connection_keyword="connection")

1604

def Introspect(self, object_path, connection):

1605

"""Overloading of standard D-Bus method.

1606

1607

Override return argument name of GetManagedObjects to be

1608

"objpath_interfaces_and_properties"

1609

"""

1610

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1611

object_path,

1612

connection)

1613

try:

1614

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

1615

1616

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

1617

# Fix argument name for the GetManagedObjects method

1618

if (if_tag.getAttribute("name")

1619

== dbus.OBJECT_MANAGER_IFACE):

1620

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

1621

if (cn.getAttribute("name")

1622

== "GetManagedObjects"):

1623

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

1624

if (arg.getAttribute("direction")

1625

== "out"):

1626

arg.setAttribute(

1627

"name",

1628

"objpath_interfaces"

1629

"_and_properties")

1630

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

1631

document.unlink()

1632

except (AttributeError, xml.dom.DOMException,

1633

xml.parsers.expat.ExpatError) as error:

1634

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

1635

exc_info=error)

1636

return xmlstring

1637

1638

1639

def datetime_to_dbus(dt, variant_level=0):

1018

def datetime_to_dbus (dt, variant_level=0):

1640

1019

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

1641

1020

if dt is None:

1642

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

1643

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

1021

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

1022

return dbus.String(dt.isoformat(),

1023

variant_level=variant_level)

1644

1024

1645

1025

1646

1026

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1648

1028

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

1649

1029

interface names according to the "alt_interface_names" mapping.

1650

1030

Usage:

1651

1652

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

1653

"net.example.AlternateInterface"})

1031

1032

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

1033

"net.example.AlternateInterface"})

1654

1034

class SampleDBusObject(dbus.service.Object):

1655

1035

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

1656

1036

def SampleDBusMethod():

1657

1037

pass

1658

1038

1659

1039

The above "SampleDBusMethod" on "SampleDBusObject" will be

1660

1040

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

1661

1041

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

1662

1042

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

1663

1043

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

1664

1044

1665

1045

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

1666

1046

(from DBusObjectWithProperties) and interfaces (from the

1667

1047

dbus_interface_annotations decorator).

1668

1048

"""

1669

1670

1049

def wrapper(cls):

1671

1050

for orig_interface_name, alt_interface_name in (

1672

alt_interface_names.items()):

1051

alt_interface_names.iteritems()):

1673

1052

attr = {}

1674

1053

interface_names = set()

1675

1054

# Go though all attributes of the class

1677

1056

# Ignore non-D-Bus attributes, and D-Bus attributes

1678

1057

# with the wrong interface name

1679

1058

if (not hasattr(attribute, "_dbus_interface")

1680

or not attribute._dbus_interface.startswith(

1681

orig_interface_name)):

1059

or not attribute._dbus_interface

1060

.startswith(orig_interface_name)):

1682

1061

continue

1683

1062

# Create an alternate D-Bus interface name based on

1684

1063

# the current name

1685

alt_interface = attribute._dbus_interface.replace(

1686

orig_interface_name, alt_interface_name)

1064

alt_interface = (attribute._dbus_interface

1065

.replace(orig_interface_name,

1066

alt_interface_name))

1687

1067

interface_names.add(alt_interface)

1688

1068

# Is this a D-Bus signal?

1689

1069

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

1690

# Extract the original non-method undecorated

1691

# function by black magic

1692

if sys.version_info.major == 2:

1693

nonmethod_func = (dict(

1070

# Extract the original non-method function by

1071

# black magic

1072

nonmethod_func = (dict(

1694

1073

zip(attribute.func_code.co_freevars,

1695

attribute.__closure__))

1696

["func"].cell_contents)

1697

else:

1698

nonmethod_func = (dict(

1699

zip(attribute.__code__.co_freevars,

1700

attribute.__closure__))

1701

["func"].cell_contents)

1074

attribute.__closure__))["func"]

1075

.cell_contents)

1702

1076

# Create a new, but exactly alike, function

1703

1077

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

1704

1078

# with the alternate D-Bus interface name

1705

new_function = copy_function(nonmethod_func)

1706

new_function = (dbus.service.signal(

1707

alt_interface,

1708

attribute._dbus_signature)(new_function))

1079

new_function = (dbus.service.signal

1080

(alt_interface,

1081

attribute._dbus_signature)

1082

(types.FunctionType(

1083

nonmethod_func.func_code,

1084

nonmethod_func.func_globals,

1085

nonmethod_func.func_name,

1086

nonmethod_func.func_defaults,

1087

nonmethod_func.func_closure)))

1709

1088

# Copy annotations, if any

1710

1089

try:

1711

new_function._dbus_annotations = dict(

1712

attribute._dbus_annotations)

1090

new_function._dbus_annotations = (

1091

dict(attribute._dbus_annotations))

1713

1092

except AttributeError:

1714

1093

pass

1715

1716

1094

# Define a creator of a function to call both the

1717

1095

# original and alternate functions, so both the

1718

1096

# original and alternate signals gets sent when

1721

1099

"""This function is a scope container to pass

1722

1100

func1 and func2 to the "call_both" function

1723

1101

outside of its arguments"""

1724

1725

@functools.wraps(func2)

1726

1102

def call_both(*args, **kwargs):

1727

1103

"""This function will emit two D-Bus

1728

1104

signals by calling func1 and func2"""

1729

1105

func1(*args, **kwargs)

1730

1106

func2(*args, **kwargs)

1731

# Make wrapper function look like a D-Bus

1732

# signal

1733

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

1734

if name.startswith("_dbus_"):

1735

setattr(call_both, name, attr)

1736

1737

1107

return call_both

1738

1108

# Create the "call_both" function and add it to

1739

1109

# the class

1744

1114

# object. Decorate it to be a new D-Bus method

1745

1115

# with the alternate D-Bus interface name. Add it

1746

1116

# to the class.

1747

attr[attrname] = (

1748

dbus.service.method(

1749

alt_interface,

1750

attribute._dbus_in_signature,

1751

attribute._dbus_out_signature)

1752

(copy_function(attribute)))

1117

attr[attrname] = (dbus.service.method

1118

(alt_interface,

1119

attribute._dbus_in_signature,

1120

attribute._dbus_out_signature)

1121

(types.FunctionType

1122

(attribute.func_code,

1123

attribute.func_globals,

1124

attribute.func_name,

1125

attribute.func_defaults,

1126

attribute.func_closure)))

1753

1127

# Copy annotations, if any

1754

1128

try:

1755

attr[attrname]._dbus_annotations = dict(

1756

attribute._dbus_annotations)

1129

attr[attrname]._dbus_annotations = (

1130

dict(attribute._dbus_annotations))

1757

1131

except AttributeError:

1758

1132

pass

1759

1133

# Is this a D-Bus property?

1762

1136

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

1763

1137

# property with the alternate D-Bus interface

1764

1138

# name. Add it to the class.

1765

attr[attrname] = (dbus_service_property(

1766

alt_interface, attribute._dbus_signature,

1767

attribute._dbus_access,

1768

attribute._dbus_get_args_options

1769

["byte_arrays"])

1770

(copy_function(attribute)))

1139

attr[attrname] = (dbus_service_property

1140

(alt_interface,

1141

attribute._dbus_signature,

1142

attribute._dbus_access,

1143

attribute

1144

._dbus_get_args_options

1145

["byte_arrays"])

1146

(types.FunctionType

1147

(attribute.func_code,

1148

attribute.func_globals,

1149

attribute.func_name,

1150

attribute.func_defaults,

1151

attribute.func_closure)))

1771

1152

# Copy annotations, if any

1772

1153

try:

1773

attr[attrname]._dbus_annotations = dict(

1774

attribute._dbus_annotations)

1154

attr[attrname]._dbus_annotations = (

1155

dict(attribute._dbus_annotations))

1775

1156

except AttributeError:

1776

1157

pass

1777

1158

# Is this a D-Bus interface?

1780

1161

# object. Decorate it to be a new D-Bus interface

1781

1162

# with the alternate D-Bus interface name. Add it

1782

1163

# to the class.

1783

attr[attrname] = (

1784

dbus_interface_annotations(alt_interface)

1785

(copy_function(attribute)))

1164

attr[attrname] = (dbus_interface_annotations

1165

(alt_interface)

1166

(types.FunctionType

1167

(attribute.func_code,

1168

attribute.func_globals,

1169

attribute.func_name,

1170

attribute.func_defaults,

1171

attribute.func_closure)))

1786

1172

if deprecate:

1787

1173

# Deprecate all alternate interfaces

1788

iname = "_AlternateDBusNames_interface_annotation{}"

1174

iname="_AlternateDBusNames_interface_annotation{0}"

1789

1175

for interface_name in interface_names:

1790

1791

1176

@dbus_interface_annotations(interface_name)

1792

1177

def func(self):

1793

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

1794

"true"}

1178

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

1179

"true" }

1795

1180

# Find an unused name

1796

1181

for aname in (iname.format(i)

1797

1182

for i in itertools.count()):

1801

1186

if interface_names:

1802

1187

# Replace the class with a new subclass of it with

1803

1188

# methods, signals, etc. as created above.

1804

if sys.version_info.major == 2:

1805

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

1806

(cls, ), attr)

1807

else:

1808

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

1809

(cls, ), attr)

1189

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

1190

(cls,), attr)

1810

1191

return cls

1811

1812

1192

return wrapper

1813

1193

1814

1194

1815

1195

@alternate_dbus_interfaces({"se.recompile.Mandos":

1816

"se.bsnet.fukt.Mandos"})

1196

"se.bsnet.fukt.Mandos"})

1817

1197

class ClientDBus(Client, DBusObjectWithProperties):

1818

1198

"""A Client class using D-Bus

1819

1199

1820

1200

Attributes:

1821

1201

dbus_object_path: dbus.ObjectPath

1822

1202

bus: dbus.SystemBus()

1823

1203

"""

1824

1204

1825

1205

runtime_expansions = (Client.runtime_expansions

1826

+ ("dbus_object_path", ))

1827

1828

_interface = "se.recompile.Mandos.Client"

1829

1206

+ ("dbus_object_path",))

1207

1830

1208

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

1831

1832

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

1209

1210

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

1833

1211

self.bus = bus

1834

1212

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

1835

1213

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

1836

1214

# the D-Bus

1837

client_object_name = str(self.name).translate(

1215

client_object_name = unicode(self.name).translate(

1838

1216

{ord("."): ord("_"),

1839

1217

ord("-"): ord("_")})

1840

self.dbus_object_path = dbus.ObjectPath(

1841

"/clients/" + client_object_name)

1218

self.dbus_object_path = (dbus.ObjectPath

1219

("/clients/" + client_object_name))

1842

1220

DBusObjectWithProperties.__init__(self, self.bus,

1843

1221

self.dbus_object_path)

1844

1845

def notifychangeproperty(transform_func, dbus_name,

1846

type_func=lambda x: x,

1847

variant_level=1,

1848

invalidate_only=False,

1849

_interface=_interface):

1222

1223

def notifychangeproperty(transform_func,

1224

dbus_name, type_func=lambda x: x,

1225

variant_level=1):

1850

1226

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

1851

1227

its changes to DBus.

1852

1228

1853

1229

transform_fun: Function that takes a value and a variant_level

1854

1230

and transforms it to a D-Bus type.

1855

1231

dbus_name: D-Bus name of the variable

1857

1233

to the D-Bus. Default: no transform

1858

1234

variant_level: D-Bus variant level. Default: 1

1859

1235

"""

1860

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

1861

1236

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

1862

1237

def setter(self, value):

1863

1238

if hasattr(self, "dbus_object_path"):

1864

1239

if (not hasattr(self, attrname) or

1865

1240

type_func(getattr(self, attrname, None))

1866

1241

!= type_func(value)):

1867

if invalidate_only:

1868

self.PropertiesChanged(

1869

_interface, dbus.Dictionary(),

1870

dbus.Array((dbus_name, )))

1871

else:

1872

dbus_value = transform_func(

1873

type_func(value),

1874

variant_level=variant_level)

1875

self.PropertyChanged(dbus.String(dbus_name),

1876

dbus_value)

1877

self.PropertiesChanged(

1878

_interface,

1879

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

1880

dbus_value}),

1881

dbus.Array())

1242

dbus_value = transform_func(type_func(value),

1243

variant_level

1244

=variant_level)

1245

self.PropertyChanged(dbus.String(dbus_name),

1246

dbus_value)

1882

1247

setattr(self, attrname, value)

1883

1248

1884

1249

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

1885

1250

1886

1251

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1887

1252

approvals_pending = notifychangeproperty(dbus.Boolean,

1888

1253

"ApprovalPending",

1889

type_func=bool)

1254

type_func = bool)

1890

1255

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

1891

1256

last_enabled = notifychangeproperty(datetime_to_dbus,

1892

1257

"LastEnabled")

1893

checker = notifychangeproperty(

1894

dbus.Boolean, "CheckerRunning",

1895

type_func=lambda checker: checker is not None)

1258

checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",

1259

type_func = lambda checker:

1260

checker is not None)

1896

1261

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1897

1262

"LastCheckedOK")

1898

1263

last_checker_status = notifychangeproperty(dbus.Int16,

1901

1266

datetime_to_dbus, "LastApprovalRequest")

1902

1267

approved_by_default = notifychangeproperty(dbus.Boolean,

1903

1268

"ApprovedByDefault")

1904

approval_delay = notifychangeproperty(

1905

dbus.UInt64, "ApprovalDelay",

1906

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

1269

approval_delay = notifychangeproperty(dbus.UInt64,

1270

"ApprovalDelay",

1271

type_func =

1272

timedelta_to_milliseconds)

1907

1273

approval_duration = notifychangeproperty(

1908

1274

dbus.UInt64, "ApprovalDuration",

1909

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

1275

type_func = timedelta_to_milliseconds)

1910

1276

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

1911

timeout = notifychangeproperty(

1912

dbus.UInt64, "Timeout",

1913

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

1277

timeout = notifychangeproperty(dbus.UInt64, "Timeout",

1278

type_func =

1279

timedelta_to_milliseconds)

1914

1280

extended_timeout = notifychangeproperty(

1915

1281

dbus.UInt64, "ExtendedTimeout",

1916

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

1917

interval = notifychangeproperty(

1918

dbus.UInt64, "Interval",

1919

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

1282

type_func = timedelta_to_milliseconds)

1283

interval = notifychangeproperty(dbus.UInt64,

1284

"Interval",

1285

type_func =

1286

timedelta_to_milliseconds)

1920

1287

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

1921

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

1922

invalidate_only=True)

1923

1288

1924

1289

del notifychangeproperty

1925

1290

1926

1291

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

1927

1292

try:

1928

1293

self.remove_from_connection()

1931

1296

if hasattr(DBusObjectWithProperties, "__del__"):

1932

1297

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

1933

1298

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

1934

1935

def checker_callback(self, source, condition,

1936

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

1937

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

1938

connection, command, *args,

1939

**kwargs)

1940

exitstatus = self.last_checker_status

1941

if exitstatus >= 0:

1299

1300

def checker_callback(self, pid, condition, command,

1301

*args, **kwargs):

1302

self.checker_callback_tag = None

1303

self.checker = None

1304

if os.WIFEXITED(condition):

1305

exitstatus = os.WEXITSTATUS(condition)

1942

1306

# Emit D-Bus signal

1943

1307

self.CheckerCompleted(dbus.Int16(exitstatus),

1944

# This is specific to GNU libC

1945

dbus.Int64(exitstatus << 8),

1308

dbus.Int64(condition),

1946

1309

dbus.String(command))

1947

1310

else:

1948

1311

# Emit D-Bus signal

1949

1312

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

1950

dbus.Int64(

1951

# This is specific to GNU libC

1952

(exitstatus << 8)

1953

| self.last_checker_signal),

1313

dbus.Int64(condition),

1954

1314

dbus.String(command))

1955

return ret

1956

1315

1316

return Client.checker_callback(self, pid, condition, command,

1317

*args, **kwargs)

1318

1957

1319

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

1958

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

1320

old_checker = self.checker

1321

if self.checker is not None:

1322

old_checker_pid = self.checker.pid

1323

else:

1324

old_checker_pid = None

1959

1325

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

1960

1326

# Only if new checker process was started

1961

1327

if (self.checker is not None

1963

1329

# Emit D-Bus signal

1964

1330

self.CheckerStarted(self.current_checker_command)

1965

1331

return r

1966

1332

1967

1333

def _reset_approved(self):

1968

1334

self.approved = None

1969

1335

return False

1970

1336

1971

1337

def approve(self, value=True):

1338

self.send_changedstate()

1972

1339

self.approved = value

1973

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

1974

* 1000), self._reset_approved)

1975

self.send_changedstate()

1976

1977

# D-Bus methods, signals & properties

1978

1979

# Interfaces

1980

1981

# Signals

1982

1340

gobject.timeout_add(timedelta_to_milliseconds

1341

(self.approval_duration),

1342

self._reset_approved)

1343

1344

## D-Bus methods, signals & properties

1345

_interface = "se.recompile.Mandos.Client"

1346

1347

## Interfaces

1348

1349

@dbus_interface_annotations(_interface)

1350

def _foo(self):

1351

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

1352

"false"}

1353

1354

## Signals

1355

1983

1356

# CheckerCompleted - signal

1984

1357

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

1985

1358

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

1986

1359

"D-Bus signal"

1987

1360

pass

1988

1361

1989

1362

# CheckerStarted - signal

1990

1363

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

1991

1364

def CheckerStarted(self, command):

1992

1365

"D-Bus signal"

1993

1366

pass

1994

1367

1995

1368

# PropertyChanged - signal

1996

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

1997

1369

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

1998

1370

def PropertyChanged(self, property, value):

1999

1371

"D-Bus signal"

2000

1372

pass

2001

1373

2002

1374

# GotSecret - signal

2003

1375

@dbus.service.signal(_interface)

2004

1376

def GotSecret(self):

2007

1379

server to mandos-client

2008

1380

"""

2009

1381

pass

2010

1382

2011

1383

# Rejected - signal

2012

1384

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

2013

1385

def Rejected(self, reason):

2014

1386

"D-Bus signal"

2015

1387

pass

2016

1388

2017

1389

# NeedApproval - signal

2018

1390

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

2019

1391

def NeedApproval(self, timeout, default):

2020

1392

"D-Bus signal"

2021

1393

return self.need_approval()

2022

2023

# Methods

2024

1394

1395

## Methods

1396

2025

1397

# Approve - method

2026

1398

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

2027

1399

def Approve(self, value):

2028

1400

self.approve(value)

2029

1401

2030

1402

# CheckedOK - method

2031

1403

@dbus.service.method(_interface)

2032

1404

def CheckedOK(self):

2033

1405

self.checked_ok()

2034

1406

2035

1407

# Enable - method

2036

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

2037

1408

@dbus.service.method(_interface)

2038

1409

def Enable(self):

2039

1410

"D-Bus method"

2040

1411

self.enable()

2041

1412

2042

1413

# StartChecker - method

2043

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

2044

1414

@dbus.service.method(_interface)

2045

1415

def StartChecker(self):

2046

1416

"D-Bus method"

2047

1417

self.start_checker()

2048

1418

2049

1419

# Disable - method

2050

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

2051

1420

@dbus.service.method(_interface)

2052

1421

def Disable(self):

2053

1422

"D-Bus method"

2054

1423

self.disable()

2055

1424

2056

1425

# StopChecker - method

2057

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

2058

1426

@dbus.service.method(_interface)

2059

1427

def StopChecker(self):

2060

1428

self.stop_checker()

2061

2062

# Properties

2063

1429

1430

## Properties

1431

2064

1432

# ApprovalPending - property

2065

1433

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

2066

1434

def ApprovalPending_dbus_property(self):

2067

1435

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

2068

1436

2069

1437

# ApprovedByDefault - property

2070

@dbus_service_property(_interface,

2071

signature="b",

1438

@dbus_service_property(_interface, signature="b",

2072

1439

access="readwrite")

2073

1440

def ApprovedByDefault_dbus_property(self, value=None):

2074

1441

if value is None: # get

2075

1442

return dbus.Boolean(self.approved_by_default)

2076

1443

self.approved_by_default = bool(value)

2077

1444

2078

1445

# ApprovalDelay - property

2079

@dbus_service_property(_interface,

2080

signature="t",

1446

@dbus_service_property(_interface, signature="t",

2081

1447

access="readwrite")

2082

1448

def ApprovalDelay_dbus_property(self, value=None):

2083

1449

if value is None: # get

2084

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

2085

* 1000)

1450

return dbus.UInt64(self.approval_delay_milliseconds())

2086

1451

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

2087

1452

2088

1453

# ApprovalDuration - property

2089

@dbus_service_property(_interface,

2090

signature="t",

1454

@dbus_service_property(_interface, signature="t",

2091

1455

access="readwrite")

2092

1456

def ApprovalDuration_dbus_property(self, value=None):

2093

1457

if value is None: # get

2094

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

2095

* 1000)

1458

return dbus.UInt64(timedelta_to_milliseconds(

1459

self.approval_duration))

2096

1460

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

2097

1461

2098

1462

# Name - property

2099

@dbus_annotations(

2100

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

2101

1463

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

2102

1464

def Name_dbus_property(self):

2103

1465

return dbus.String(self.name)

2104

2105

# KeyID - property

2106

@dbus_annotations(

2107

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

2108

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

2109

def KeyID_dbus_property(self):

2110

return dbus.String(self.key_id)

2111

1466

2112

1467

# Fingerprint - property

2113

@dbus_annotations(

2114

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

2115

1468

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

2116

1469

def Fingerprint_dbus_property(self):

2117

1470

return dbus.String(self.fingerprint)

2118

1471

2119

1472

# Host - property

2120

@dbus_service_property(_interface,

2121

signature="s",

1473

@dbus_service_property(_interface, signature="s",

2122

1474

access="readwrite")

2123

1475

def Host_dbus_property(self, value=None):

2124

1476

if value is None: # get

2125

1477

return dbus.String(self.host)

2126

self.host = str(value)

2127

1478

self.host = unicode(value)

1479

2128

1480

# Created - property

2129

@dbus_annotations(

2130

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

2131

1481

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

2132

1482

def Created_dbus_property(self):

2133

1483

return datetime_to_dbus(self.created)

2134

1484

2135

1485

# LastEnabled - property

2136

1486

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

2137

1487

def LastEnabled_dbus_property(self):

2138

1488

return datetime_to_dbus(self.last_enabled)

2139

1489

2140

1490

# Enabled - property

2141

@dbus_service_property(_interface,

2142

signature="b",

1491

@dbus_service_property(_interface, signature="b",

2143

1492

access="readwrite")

2144

1493

def Enabled_dbus_property(self, value=None):

2145

1494

if value is None: # get

2148

1497

self.enable()

2149

1498

else:

2150

1499

self.disable()

2151

1500

2152

1501

# LastCheckedOK - property

2153

@dbus_service_property(_interface,

2154

signature="s",

1502

@dbus_service_property(_interface, signature="s",

2155

1503

access="readwrite")

2156

1504

def LastCheckedOK_dbus_property(self, value=None):

2157

1505

if value is not None:

2158

1506

self.checked_ok()

2159

1507

return

2160

1508

return datetime_to_dbus(self.last_checked_ok)

2161

1509

2162

1510

# LastCheckerStatus - property

2163

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

1511

@dbus_service_property(_interface, signature="n",

1512

access="read")

2164

1513

def LastCheckerStatus_dbus_property(self):

2165

1514

return dbus.Int16(self.last_checker_status)

2166

1515

2167

1516

# Expires - property

2168

1517

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

2169

1518

def Expires_dbus_property(self):

2170

1519

return datetime_to_dbus(self.expires)

2171

1520

2172

1521

# LastApprovalRequest - property

2173

1522

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

2174

1523

def LastApprovalRequest_dbus_property(self):

2175

1524

return datetime_to_dbus(self.last_approval_request)

2176

1525

2177

1526

# Timeout - property

2178

@dbus_service_property(_interface,

2179

signature="t",

1527

@dbus_service_property(_interface, signature="t",

2180

1528

access="readwrite")

2181

1529

def Timeout_dbus_property(self, value=None):

2182

1530

if value is None: # get

2183

return dbus.UInt64(self.timeout.total_seconds() * 1000)

2184

old_timeout = self.timeout

1531

return dbus.UInt64(self.timeout_milliseconds())

2185

1532

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

2186

# Reschedule disabling

1533

# Reschedule timeout

2187

1534

if self.enabled:

2188

1535

now = datetime.datetime.utcnow()

2189

self.expires += self.timeout - old_timeout

2190

if self.expires <= now:

1536

time_to_die = timedelta_to_milliseconds(

1537

(self.last_checked_ok + self.timeout) - now)

1538

if time_to_die <= 0:

2191

1539

# The timeout has passed

2192

1540

self.disable()

2193

1541

else:

1542

self.expires = (now +

1543

datetime.timedelta(milliseconds =

1544

time_to_die))

2194

1545

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

2195

1546

is None):

2196

1547

return

2197

GLib.source_remove(self.disable_initiator_tag)

2198

self.disable_initiator_tag = GLib.timeout_add(

2199

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

2200

self.disable)

2201

1548

gobject.source_remove(self.disable_initiator_tag)

1549

self.disable_initiator_tag = (gobject.timeout_add

1550

(time_to_die,

1551

self.disable))

1552

2202

1553

# ExtendedTimeout - property

2203

@dbus_service_property(_interface,

2204

signature="t",

1554

@dbus_service_property(_interface, signature="t",

2205

1555

access="readwrite")

2206

1556

def ExtendedTimeout_dbus_property(self, value=None):

2207

1557

if value is None: # get

2208

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

2209

* 1000)

1558

return dbus.UInt64(self.extended_timeout_milliseconds())

2210

1559

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

2211

1560

2212

1561

# Interval - property

2213

@dbus_service_property(_interface,

2214

signature="t",

1562

@dbus_service_property(_interface, signature="t",

2215

1563

access="readwrite")

2216

1564

def Interval_dbus_property(self, value=None):

2217

1565

if value is None: # get

2218

return dbus.UInt64(self.interval.total_seconds() * 1000)

1566

return dbus.UInt64(self.interval_milliseconds())

2219

1567

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

2220

1568

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

2221

1569

return

2222

1570

if self.enabled:

2223

1571

# Reschedule checker run

2224

GLib.source_remove(self.checker_initiator_tag)

2225

self.checker_initiator_tag = GLib.timeout_add(

2226

value, self.start_checker)

2227

self.start_checker() # Start one now, too

2228

1572

gobject.source_remove(self.checker_initiator_tag)

1573

self.checker_initiator_tag = (gobject.timeout_add

1574

(value, self.start_checker))

1575

self.start_checker() # Start one now, too

1576

2229

1577

# Checker - property

2230

@dbus_service_property(_interface,

2231

signature="s",

1578

@dbus_service_property(_interface, signature="s",

2232

1579

access="readwrite")

2233

1580

def Checker_dbus_property(self, value=None):

2234

1581

if value is None: # get

2235

1582

return dbus.String(self.checker_command)

2236

self.checker_command = str(value)

2237

1583

self.checker_command = unicode(value)

1584

2238

1585

# CheckerRunning - property

2239

@dbus_service_property(_interface,

2240

signature="b",

1586

@dbus_service_property(_interface, signature="b",

2241

1587

access="readwrite")

2242

1588

def CheckerRunning_dbus_property(self, value=None):

2243

1589

if value is None: # get

2246

1592

self.start_checker()

2247

1593

else:

2248

1594

self.stop_checker()

2249

1595

2250

1596

# ObjectPath - property

2251

@dbus_annotations(

2252

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

2253

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

2254

1597

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

2255

1598

def ObjectPath_dbus_property(self):

2256

return self.dbus_object_path # is already a dbus.ObjectPath

2257

1599

return self.dbus_object_path # is already a dbus.ObjectPath

1600

2258

1601

# Secret = property

2259

@dbus_annotations(

2260

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

2261

"invalidates"})

2262

@dbus_service_property(_interface,

2263

signature="ay",

2264

access="write",

2265

byte_arrays=True)

1602

@dbus_service_property(_interface, signature="ay",

1603

access="write", byte_arrays=True)

2266

1604

def Secret_dbus_property(self, value):

2267

self.secret = bytes(value)

2268

1605

self.secret = str(value)

1606

2269

1607

del _interface

2270

1608

2271

1609

2272

class ProxyClient:

2273

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

1610

class ProxyClient(object):

1611

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

2274

1612

self._pipe = child_pipe

2275

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

1613

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

2276

1614

if not self._pipe.recv():

2277

raise KeyError(key_id or fpr)

2278

1615

raise KeyError()

1616

2279

1617

def __getattribute__(self, name):

2280

if name == "_pipe":

1618

if name == '_pipe':

2281

1619

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

2282

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

1620

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

2283

1621

data = self._pipe.recv()

2284

if data[0] == "data":

1622

if data[0] == 'data':

2285

1623

return data[1]

2286

if data[0] == "function":

2287

1624

if data[0] == 'function':

2288

1625

def func(*args, **kwargs):

2289

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

1626

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

2290

1627

return self._pipe.recv()[1]

2291

2292

1628

return func

2293

1629

2294

1630

def __setattr__(self, name, value):

2295

if name == "_pipe":

1631

if name == '_pipe':

2296

1632

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

2297

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

1633

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

2298

1634

2299

1635

2300

1636

class ClientHandler(socketserver.BaseRequestHandler, object):

2301

1637

"""A class to handle client connections.

2302

1638

2303

1639

Instantiated once for each connection to handle it.

2304

1640

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

2305

1641

2306

1642

def handle(self):

2307

1643

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

2308

1644

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

2309

str(self.client_address))

1645

unicode(self.client_address))

2310

1646

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

2311

1647

self.server.child_pipe.fileno())

2312

2313

session = gnutls.ClientSession(self.request)

2314

2315

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

2316

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

2317

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

2318

# "+DHE-DSS"))

1648

1649

session = (gnutls.connection

1650

.ClientSession(self.request,

1651

gnutls.connection

1652

.X509Credentials()))

1653

1654

# Note: gnutls.connection.X509Credentials is really a

1655

# generic GnuTLS certificate credentials object so long as

1656

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

1657

# here despite using OpenPGP certificates.

1658

1659

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

1660

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

1661

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

1662

# "+DHE-DSS"))

2319

1663

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

2320

1664

priority = self.server.gnutls_priority

2321

1665

if priority is None:

2322

1666

priority = "NORMAL"

2323

gnutls.priority_set_direct(session,

2324

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

2325

1667

(gnutls.library.functions

1668

.gnutls_priority_set_direct(session._c_object,

1669

priority, None))

1670

2326

1671

# Start communication using the Mandos protocol

2327

1672

# Get protocol number

2328

1673

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

2329

1674

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

2330

1675

try:

2331

1676

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

2332

raise RuntimeError(line)

1677

raise RuntimeError

2333

1678

except (ValueError, IndexError, RuntimeError) as error:

2334

1679

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

2335

1680

return

2336

1681

2337

1682

# Start GnuTLS connection

2338

1683

try:

2339

1684

session.handshake()

2340

except gnutls.Error as error:

1685

except gnutls.errors.GNUTLSError as error:

2341

1686

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

2342

1687

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

2343

1688

# established. Just abandon the request.

2344

1689

return

2345

1690

logger.debug("Handshake succeeded")

2346

1691

2347

1692

approval_required = False

2348

1693

try:

2349

if gnutls.has_rawpk:

2350

fpr = b""

2351

try:

2352

key_id = self.key_id(

2353

self.peer_certificate(session))

2354

except (TypeError, gnutls.Error) as error:

2355

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

2356

return

2357

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

2358

key_id.decode("utf-8",

2359

errors="replace"))

2360

2361

else:

2362

key_id = b""

2363

try:

2364

fpr = self.fingerprint(

2365

self.peer_certificate(session))

2366

except (TypeError, gnutls.Error) as error:

2367

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

2368

return

2369

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

2370

2371

try:

2372

client = ProxyClient(child_pipe, key_id, fpr,

1694

try:

1695

fpr = self.fingerprint(self.peer_certificate

1696

(session))

1697

except (TypeError,

1698

gnutls.errors.GNUTLSError) as error:

1699

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

1700

return

1701

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

1702

1703

try:

1704

client = ProxyClient(child_pipe, fpr,

2373

1705

self.client_address)

2374

1706

except KeyError:

2375

1707

return

2376

1708

2377

1709

if client.approval_delay:

2378

1710

delay = client.approval_delay

2379

1711

client.approvals_pending += 1

2380

1712

approval_required = True

2381

1713

2382

1714

while True:

2383

1715

if not client.enabled:

2384

1716

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

2385

client.name)

1717

client.name)

2386

1718

if self.server.use_dbus:

2387

1719

# Emit D-Bus signal

2388

1720

client.Rejected("Disabled")

2389

1721

return

2390

1722

2391

1723

if client.approved or not client.approval_delay:

2392

# We are approved or approval is disabled

1724

#We are approved or approval is disabled

2393

1725

break

2394

1726

elif client.approved is None:

2395

1727

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

2397

1729

if self.server.use_dbus:

2398

1730

# Emit D-Bus signal

2399

1731

client.NeedApproval(

2400

client.approval_delay.total_seconds()

2401

* 1000, client.approved_by_default)

1732

client.approval_delay_milliseconds(),

1733

client.approved_by_default)

2402

1734

else:

2403

1735

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

2404

1736

client.name)

2406

1738

# Emit D-Bus signal

2407

1739

client.Rejected("Denied")

2408

1740

return

2409

2410

# wait until timeout or approved

1741

1742

#wait until timeout or approved

2411

1743

time = datetime.datetime.now()

2412

1744

client.changedstate.acquire()

2413

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

1745

(client.changedstate.wait

1746

(float(client.timedelta_to_milliseconds(delay)

1747

/ 1000)))

2414

1748

client.changedstate.release()

2415

1749

time2 = datetime.datetime.now()

2416

1750

if (time2 - time) >= delay:

2426

1760

break

2427

1761

else:

2428

1762

delay -= time2 - time

2429

2430

try:

2431

session.send(client.secret)

2432

except gnutls.Error as error:

2433

logger.warning("gnutls send failed",

2434

exc_info=error)

2435

return

2436

1763

1764

sent_size = 0

1765

while sent_size < len(client.secret):

1766

try:

1767

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

1768

except gnutls.errors.GNUTLSError as error:

1769

logger.warning("gnutls send failed",

1770

exc_info=error)

1771

return

1772

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

1773

sent, len(client.secret)

1774

- (sent_size + sent))

1775

sent_size += sent

1776

2437

1777

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

2438

1778

# bump the timeout using extended_timeout

2439

1779

client.bump_timeout(client.extended_timeout)

2440

1780

if self.server.use_dbus:

2441

1781

# Emit D-Bus signal

2442

1782

client.GotSecret()

2443

1783

2444

1784

finally:

2445

1785

if approval_required:

2446

1786

client.approvals_pending -= 1

2447

1787

try:

2448

1788

session.bye()

2449

except gnutls.Error as error:

1789

except gnutls.errors.GNUTLSError as error:

2450

1790

logger.warning("GnuTLS bye failed",

2451

1791

exc_info=error)

2452

1792

2453

1793

@staticmethod

2454

1794

def peer_certificate(session):

2455

"Return the peer's certificate as a bytestring"

2456

try:

2457

cert_type = gnutls.certificate_type_get2(

2458

session, gnutls.CTYPE_PEERS)

2459

except AttributeError:

2460

cert_type = gnutls.certificate_type_get(session)

2461

if gnutls.has_rawpk:

2462

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2463

else:

2464

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2465

# If not a valid certificate type...

2466

if cert_type not in valid_cert_types:

2467

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

2468

valid_cert_types)

2469

# ...return invalid data

2470

return b""

1795

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

1796

# If not an OpenPGP certificate...

1797

if (gnutls.library.functions

1798

.gnutls_certificate_type_get(session._c_object)

1799

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1800

# ...do the normal thing

1801

return session.peer_certificate

2471

1802

list_size = ctypes.c_uint(1)

2472

cert_list = (gnutls.certificate_get_peers

2473

(session, ctypes.byref(list_size)))

1803

cert_list = (gnutls.library.functions

1804

.gnutls_certificate_get_peers

1805

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

2474

1806

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

2475

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

1807

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

1808

" certificate")

2476

1809

if list_size.value == 0:

2477

1810

return None

2478

1811

cert = cert_list[0]

2479

1812

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

2480

2481

@staticmethod

2482

def key_id(certificate):

2483

"Convert a certificate bytestring to a hexdigit key ID"

2484

# New GnuTLS "datum" with the public key

2485

datum = gnutls.datum_t(

2486

ctypes.cast(ctypes.c_char_p(certificate),

2487

ctypes.POINTER(ctypes.c_ubyte)),

2488

ctypes.c_uint(len(certificate)))

2489

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

2490

# New empty GnuTLS certificate

2491

pubkey = gnutls.pubkey_t()

2492

gnutls.pubkey_init(ctypes.byref(pubkey))

2493

# Import the raw public key into the certificate

2494

gnutls.pubkey_import(pubkey,

2495

ctypes.byref(datum),

2496

gnutls.X509_FMT_DER)

2497

# New buffer for the key ID

2498

buf = ctypes.create_string_buffer(32)

2499

buf_len = ctypes.c_size_t(len(buf))

2500

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

2501

gnutls.pubkey_get_key_id(

2502

pubkey,

2503

gnutls.KEYID_USE_SHA256,

2504

ctypes.cast(ctypes.byref(buf),

2505

ctypes.POINTER(ctypes.c_ubyte)),

2506

ctypes.byref(buf_len))

2507

# Deinit the certificate

2508

gnutls.pubkey_deinit(pubkey)

2509

2510

# Convert the buffer to a Python bytestring

2511

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

2512

# Convert the bytestring to hexadecimal notation

2513

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

2514

return hex_key_id

2515

1813

2516

1814

@staticmethod

2517

1815

def fingerprint(openpgp):

2518

1816

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2519

1817

# New GnuTLS "datum" with the OpenPGP public key

2520

datum = gnutls.datum_t(

2521

ctypes.cast(ctypes.c_char_p(openpgp),

2522

ctypes.POINTER(ctypes.c_ubyte)),

2523

ctypes.c_uint(len(openpgp)))

1818

datum = (gnutls.library.types

1819

.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),

1820

ctypes.POINTER

1821

(ctypes.c_ubyte)),

1822

ctypes.c_uint(len(openpgp))))

2524

1823

# New empty GnuTLS certificate

2525

crt = gnutls.openpgp_crt_t()

2526

gnutls.openpgp_crt_init(ctypes.byref(crt))

1824

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1825

(gnutls.library.functions

1826

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2527

1827

# Import the OpenPGP public key into the certificate

2528

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

2529

gnutls.OPENPGP_FMT_RAW)

1828

(gnutls.library.functions

1829

.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),

1830

gnutls.library.constants

1831

.GNUTLS_OPENPGP_FMT_RAW))

2530

1832

# Verify the self signature in the key

2531

1833

crtverify = ctypes.c_uint()

2532

gnutls.openpgp_crt_verify_self(crt, 0,

2533

ctypes.byref(crtverify))

1834

(gnutls.library.functions

1835

.gnutls_openpgp_crt_verify_self(crt, 0,

1836

ctypes.byref(crtverify)))

2534

1837

if crtverify.value != 0:

2535

gnutls.openpgp_crt_deinit(crt)

2536

raise gnutls.CertificateSecurityError(code

2537

=crtverify.value)

1838

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1839

raise (gnutls.errors.CertificateSecurityError

1840

("Verify failed"))

2538

1841

# New buffer for the fingerprint

2539

1842

buf = ctypes.create_string_buffer(20)

2540

1843

buf_len = ctypes.c_size_t()

2541

1844

# Get the fingerprint from the certificate into the buffer

2542

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

2543

ctypes.byref(buf_len))

1845

(gnutls.library.functions

1846

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

1847

ctypes.byref(buf_len)))

2544

1848

# Deinit the certificate

2545

gnutls.openpgp_crt_deinit(crt)

1849

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2546

1850

# Convert the buffer to a Python bytestring

2547

1851

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

2548

1852

# Convert the bytestring to hexadecimal notation

2550

1854

return hex_fpr

2551

1855

2552

1856

2553

class MultiprocessingMixIn:

1857

class MultiprocessingMixIn(object):

2554

1858

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

2555

2556

1859

def sub_process_main(self, request, address):

2557

1860

try:

2558

1861

self.finish_request(request, address)

2559

1862

except Exception:

2560

1863

self.handle_error(request, address)

2561

1864

self.close_request(request)

2562

1865

2563

1866

def process_request(self, request, address):

2564

1867

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

2565

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

2566

args=(request, address))

1868

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

1869

args = (request, address))

2567

1870

proc.start()

2568

1871

return proc

2569

1872

2570

1873

2571

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1874

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2572

1875

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

2573

2574

1876

def process_request(self, request, client_address):

2575

1877

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

2576

1878

2577

1879

This function creates a new pipe in self.pipe

2578

1880

"""

2579

1881

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2580

1882

2581

1883

proc = MultiprocessingMixIn.process_request(self, request,

2582

1884

client_address)

2583

1885

self.child_pipe.close()

2584

1886

self.add_pipe(parent_pipe, proc)

2585

1887

2586

1888

def add_pipe(self, parent_pipe, proc):

2587

1889

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

2588

raise NotImplementedError()

1890

raise NotImplementedError

2589

1891

2590

1892

2591

1893

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2592

socketserver.TCPServer):

2593

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

2594

1894

socketserver.TCPServer, object):

1895

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

1896

2595

1897

Attributes:

2596

1898

enabled: Boolean; whether this server is activated yet

2597

1899

interface: None or a network interface name (string)

2598

1900

use_ipv6: Boolean; to use IPv6 or not

2599

1901

"""

2600

2601

1902

def __init__(self, server_address, RequestHandlerClass,

2602

interface=None,

2603

use_ipv6=True,

2604

socketfd=None):

2605

"""If socketfd is set, use that file descriptor instead of

2606

creating a new one with socket.socket().

2607

"""

1903

interface=None, use_ipv6=True):

2608

1904

self.interface = interface

2609

1905

if use_ipv6:

2610

1906

self.address_family = socket.AF_INET6

2611

if socketfd is not None:

2612

# Save the file descriptor

2613

self.socketfd = socketfd

2614

# Save the original socket.socket() function

2615

self.socket_socket = socket.socket

2616

2617

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

2618

#

2619

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

2620

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

2621

# patching socket.socket.)

2622

#

2623

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

2624

@functools.wraps(socket.socket)

2625

def socket_wrapper(*args, **kwargs):

2626

# Restore original function so subsequent calls are

2627

# not affected.

2628

socket.socket = self.socket_socket

2629

del self.socket_socket

2630

# This time only, return a new socket object from the

2631

# saved file descriptor.

2632

return socket.fromfd(self.socketfd, *args, **kwargs)

2633

# Replace socket.socket() function with wrapper

2634

socket.socket = socket_wrapper

2635

# The socketserver.TCPServer.__init__ will call

2636

# socket.socket(), which might be our replacement,

2637

# socket_wrapper(), if socketfd was set.

2638

1907

socketserver.TCPServer.__init__(self, server_address,

2639

1908

RequestHandlerClass)

2640

2641

1909

def server_bind(self):

2642

1910

"""This overrides the normal server_bind() function

2643

1911

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

2644

1912

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

2645

global SO_BINDTODEVICE

2646

1913

if self.interface is not None:

2647

1914

if SO_BINDTODEVICE is None:

2648

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

2649

# common enough.

2650

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

2651

SO_BINDTODEVICE = 25

2652

try:

2653

self.socket.setsockopt(

2654

socket.SOL_SOCKET, SO_BINDTODEVICE,

2655

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

2656

except socket.error as error:

2657

if error.errno == errno.EPERM:

2658

logger.error("No permission to bind to"

2659

" interface %s", self.interface)

2660

elif error.errno == errno.ENOPROTOOPT:

2661

logger.error("SO_BINDTODEVICE not available;"

2662

" cannot bind to interface %s",

2663

self.interface)

2664

elif error.errno == errno.ENODEV:

2665

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

2666

" cannot bind", self.interface)

2667

else:

2668

raise

1915

logger.error("SO_BINDTODEVICE does not exist;"

1916

" cannot bind to interface %s",

1917

self.interface)

1918

else:

1919

try:

1920

self.socket.setsockopt(socket.SOL_SOCKET,

1921

SO_BINDTODEVICE,

1922

str(self.interface

1923

+ '\0'))

1924

except socket.error as error:

1925

if error[0] == errno.EPERM:

1926

logger.error("No permission to"

1927

" bind to interface %s",

1928

self.interface)

1929

elif error[0] == errno.ENOPROTOOPT:

1930

logger.error("SO_BINDTODEVICE not available;"

1931

" cannot bind to interface %s",

1932

self.interface)

1933

else:

1934

raise

2669

1935

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

2670

1936

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

2671

if self.server_address[1]:

2672

self.allow_reuse_address = True

2673

1937

if not self.server_address[0]:

2674

1938

if self.address_family == socket.AF_INET6:

2675

any_address = "::" # in6addr_any

1939

any_address = "::" # in6addr_any

2676

1940

else:

2677

any_address = "0.0.0.0" # INADDR_ANY

1941

any_address = socket.INADDR_ANY

2678

1942

self.server_address = (any_address,

2679

1943

self.server_address[1])

2680

1944

elif not self.server_address[1]:

2681

self.server_address = (self.server_address[0], 0)

1945

self.server_address = (self.server_address[0],

1946

0)

2682

1947

# if self.interface:

2683

1948

# self.server_address = (self.server_address[0],

2684

1949

# 0, # port

2690

1955

2691

1956

class MandosServer(IPv6_TCPServer):

2692

1957

"""Mandos server.

2693

1958

2694

1959

Attributes:

2695

1960

clients: set of Client objects

2696

1961

gnutls_priority GnuTLS priority string

2697

1962

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

2698

2699

Assumes a GLib.MainLoop event loop.

1963

1964

Assumes a gobject.MainLoop event loop.

2700

1965

"""

2701

2702

1966

def __init__(self, server_address, RequestHandlerClass,

2703

interface=None,

2704

use_ipv6=True,

2705

clients=None,

2706

gnutls_priority=None,

2707

use_dbus=True,

2708

socketfd=None):

1967

interface=None, use_ipv6=True, clients=None,

1968

gnutls_priority=None, use_dbus=True):

2709

1969

self.enabled = False

2710

1970

self.clients = clients

2711

1971

if self.clients is None:

2714

1974

self.gnutls_priority = gnutls_priority

2715

1975

IPv6_TCPServer.__init__(self, server_address,

2716

1976

RequestHandlerClass,

2717

interface=interface,

2718

use_ipv6=use_ipv6,

2719

socketfd=socketfd)

2720

1977

interface = interface,

1978

use_ipv6 = use_ipv6)

2721

1979

def server_activate(self):

2722

1980

if self.enabled:

2723

1981

return socketserver.TCPServer.server_activate(self)

2724

1982

2725

1983

def enable(self):

2726

1984

self.enabled = True

2727

1985

2728

1986

def add_pipe(self, parent_pipe, proc):

2729

1987

# Call "handle_ipc" for both data and EOF events

2730

GLib.io_add_watch(

2731

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

2732

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

2733

functools.partial(self.handle_ipc,

2734

parent_pipe=parent_pipe,

2735

proc=proc))

2736

2737

def handle_ipc(self, source, condition,

2738

parent_pipe=None,

2739

proc=None,

2740

client_object=None):

1988

gobject.io_add_watch(parent_pipe.fileno(),

1989

gobject.IO_IN | gobject.IO_HUP,

1990

functools.partial(self.handle_ipc,

1991

parent_pipe =

1992

parent_pipe,

1993

proc = proc))

1994

1995

def handle_ipc(self, source, condition, parent_pipe=None,

1996

proc = None, client_object=None):

2741

1997

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

2742

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

1998

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

2743

1999

# Wait for other process to exit

2744

2000

proc.join()

2745

2001

return False

2746

2002

2747

2003

# Read a request from the child

2748

2004

request = parent_pipe.recv()

2749

2005

command = request[0]

2750

2751

if command == "init":

2752

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

2753

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

2754

address = request[3]

2755

2756

for c in self.clients.values():

2757

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2758

"27AE41E4649B934CA495991B7852B855"):

2759

continue

2760

if key_id and c.key_id == key_id:

2761

client = c

2762

break

2763

if fpr and c.fingerprint == fpr:

2006

2007

if command == 'init':

2008

fpr = request[1]

2009

address = request[2]

2010

2011

for c in self.clients.itervalues():

2012

if c.fingerprint == fpr:

2764

2013

client = c

2765

2014

break

2766

2015

else:

2767

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

2768

": %s", key_id or fpr, address)

2016

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

2017

"dress: %s", fpr, address)

2769

2018

if self.use_dbus:

2770

2019

# Emit D-Bus signal

2771

mandos_dbus_service.ClientNotFound(key_id or fpr,

2020

mandos_dbus_service.ClientNotFound(fpr,

2772

2021

address[0])

2773

2022

parent_pipe.send(False)

2774

2023

return False

2775

2776

GLib.io_add_watch(

2777

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

2778

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

2779

functools.partial(self.handle_ipc,

2780

parent_pipe=parent_pipe,

2781

proc=proc,

2782

client_object=client))

2024

2025

gobject.io_add_watch(parent_pipe.fileno(),

2026

gobject.IO_IN | gobject.IO_HUP,

2027

functools.partial(self.handle_ipc,

2028

parent_pipe =

2029

parent_pipe,

2030

proc = proc,

2031

client_object =

2032

client))

2783

2033

parent_pipe.send(True)

2784

2034

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

2785

2035

# same fileno

2786

2036

return False

2787

if command == "funcall":

2037

if command == 'funcall':

2788

2038

funcname = request[1]

2789

2039

args = request[2]

2790

2040

kwargs = request[3]

2791

2792

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

2041

2042

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

2793

2043

funcname)(*args,

2794

**kwargs)))

2795

2796

if command == "getattr":

2044

**kwargs)))

2045

2046

if command == 'getattr':

2797

2047

attrname = request[1]

2798

if isinstance(client_object.__getattribute__(attrname),

2799

collections.abc.Callable):

2800

parent_pipe.send(("function", ))

2048

if callable(client_object.__getattribute__(attrname)):

2049

parent_pipe.send(('function',))

2801

2050

else:

2802

parent_pipe.send((

2803

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

2804

2805

if command == "setattr":

2051

parent_pipe.send(('data', client_object

2052

.__getattribute__(attrname)))

2053

2054

if command == 'setattr':

2806

2055

attrname = request[1]

2807

2056

value = request[2]

2808

2057

setattr(client_object, attrname, value)

2809

2058

2810

2059

return True

2811

2060

2812

2061

2813

def rfc3339_duration_to_delta(duration):

2814

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

2815

2816

>>> timedelta = datetime.timedelta

2817

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

2818

True

2819

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

2820

True

2821

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

2822

True

2823

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

2824

True

2825

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

2826

True

2827

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

2828

True

2829

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

2830

True

2831

>>> del timedelta

2832

"""

2833

2834

# Parsing an RFC 3339 duration with regular expressions is not

2835

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

2836

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

2837

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

2838

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

2839

# avoid excessive use of external libraries.

2840

2841

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

2842

Token = collections.namedtuple("Token", (

2843

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

2844

# a "group" containing digits

2845

"value", # datetime.timedelta or None

2846

"followers")) # Tokens valid after this token

2847

# RFC 3339 "duration" tokens, syntax, and semantics; taken from

2848

# the "duration" ABNF definition in RFC 3339, Appendix A.

2849

token_end = Token(re.compile(r"$"), None, frozenset())

2850

token_second = Token(re.compile(r"(\d+)S"),

2851

datetime.timedelta(seconds=1),

2852

frozenset((token_end, )))

2853

token_minute = Token(re.compile(r"(\d+)M"),

2854

datetime.timedelta(minutes=1),

2855

frozenset((token_second, token_end)))

2856

token_hour = Token(re.compile(r"(\d+)H"),

2857

datetime.timedelta(hours=1),

2858

frozenset((token_minute, token_end)))

2859

token_time = Token(re.compile(r"T"),

2860

None,

2861

frozenset((token_hour, token_minute,

2862

token_second)))

2863

token_day = Token(re.compile(r"(\d+)D"),

2864

datetime.timedelta(days=1),

2865

frozenset((token_time, token_end)))

2866

token_month = Token(re.compile(r"(\d+)M"),

2867

datetime.timedelta(weeks=4),

2868

frozenset((token_day, token_end)))

2869

token_year = Token(re.compile(r"(\d+)Y"),

2870

datetime.timedelta(weeks=52),

2871

frozenset((token_month, token_end)))

2872

token_week = Token(re.compile(r"(\d+)W"),

2873

datetime.timedelta(weeks=1),

2874

frozenset((token_end, )))

2875

token_duration = Token(re.compile(r"P"), None,

2876

frozenset((token_year, token_month,

2877

token_day, token_time,

2878

token_week)))

2879

# Define starting values:

2880

# Value so far

2881

value = datetime.timedelta()

2882

found_token = None

2883

# Following valid tokens

2884

followers = frozenset((token_duration, ))

2885

# String left to parse

2886

s = duration

2887

# Loop until end token is found

2888

while found_token is not token_end:

2889

# Search for any currently valid tokens

2890

for token in followers:

2891

match = token.regexp.match(s)

2892

if match is not None:

2893

# Token found

2894

if token.value is not None:

2895

# Value found, parse digits

2896

factor = int(match.group(1), 10)

2897

# Add to value so far

2898

value += factor * token.value

2899

# Strip token from string

2900

s = token.regexp.sub("", s, 1)

2901

# Go to found token

2902

found_token = token

2903

# Set valid next tokens

2904

followers = found_token.followers

2905

break

2906

else:

2907

# No currently valid tokens were found

2908

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

2909

.format(duration))

2910

# End token found

2911

return value

2912

2913

2914

2062

def string_to_delta(interval):

2915

2063

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

2916

2917

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

2918

True

2919

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

2920

True

2921

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

2922

True

2923

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

2924

True

2925

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

2926

True

2927

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

2928

True

2064

2065

>>> string_to_delta('7d')

2066

datetime.timedelta(7)

2067

>>> string_to_delta('60s')

2068

datetime.timedelta(0, 60)

2069

>>> string_to_delta('60m')

2070

datetime.timedelta(0, 3600)

2071

>>> string_to_delta('24h')

2072

datetime.timedelta(1)

2073

>>> string_to_delta('1w')

2074

datetime.timedelta(7)

2075

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

2076

datetime.timedelta(0, 330)

2929

2077

"""

2930

2931

try:

2932

return rfc3339_duration_to_delta(interval)

2933

except ValueError:

2934

pass

2935

2936

2078

timevalue = datetime.timedelta(0)

2937

2079

for s in interval.split():

2938

2080

try:

2939

suffix = s[-1]

2081

suffix = unicode(s[-1])

2940

2082

value = int(s[:-1])

2941

2083

if suffix == "d":

2942

2084

delta = datetime.timedelta(value)

2949

2091

elif suffix == "w":

2950

2092

delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)

2951

2093

else:

2952

raise ValueError("Unknown suffix {!r}".format(suffix))

2953

except IndexError as e:

2094

raise ValueError("Unknown suffix {0!r}"

2095

.format(suffix))

2096

except (ValueError, IndexError) as e:

2954

2097

raise ValueError(*(e.args))

2955

2098

timevalue += delta

2956

2099

return timevalue

2957

2100

2958

2101

2959

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

2102

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

2960

2103

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

2961

2104

2962

2105

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

2963

2106

if os.fork():

2964

2107

sys.exit()

2972

2115

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

2973

2116

if not stat.S_ISCHR(os.fstat(null).st_mode):

2974

2117

raise OSError(errno.ENODEV,

2975

"{} not a character device"

2118

"{0} not a character device"

2976

2119

.format(os.devnull))

2977

2120

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

2978

2121

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

2982

2125

2983

2126

2984

2127

def main():

2985

2128

2986

2129

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

2987

2130

# Parsing of options, both command line and config file

2988

2131

2989

2132

parser = argparse.ArgumentParser()

2990

2133

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

2991

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

2134

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

2992

2135

help="show version number and exit")

2993

2136

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

2994

2137

help="Bind to interface IF")

3000

2143

help="Run self-test")

3001

2144

parser.add_argument("--debug", action="store_true",

3002

2145

help="Debug mode; run in foreground and log"

3003

" to terminal", default=None)

2146

" to terminal")

3004

2147

parser.add_argument("--debuglevel", metavar="LEVEL",

3005

2148

help="Debug level for stdout output")

3006

2149

parser.add_argument("--priority", help="GnuTLS"

3013

2156

" files")

3014

2157

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

3015

2158

dest="use_dbus", help="Do not provide D-Bus"

3016

" system bus interface", default=None)

2159

" system bus interface")

3017

2160

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

3018

dest="use_ipv6", help="Do not use IPv6",

3019

default=None)

2161

dest="use_ipv6", help="Do not use IPv6")

3020

2162

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

3021

2163

dest="restore", help="Do not restore stored"

3022

" state", default=None)

3023

parser.add_argument("--socket", type=int,

3024

help="Specify a file descriptor to a network"

3025

" socket to use instead of creating one")

2164

" state")

3026

2165

parser.add_argument("--statedir", metavar="DIR",

3027

2166

help="Directory to save/restore state in")

3028

parser.add_argument("--foreground", action="store_true",

3029

help="Run in foreground", default=None)

3030

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

3031

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

3032

default=None)

3033

2167

3034

2168

options = parser.parse_args()

3035

2169

2170

if options.check:

2171

import doctest

2172

doctest.testmod()

2173

sys.exit()

2174

3036

2175

# Default values for config file for server-global settings

3037

if gnutls.has_rawpk:

3038

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

3039

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

3040

else:

3041

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

3042

":+SIGN-DSA-SHA256")

3043

server_defaults = {"interface": "",

3044

"address": "",

3045

"port": "",

3046

"debug": "False",

3047

"priority": priority,

3048

"servicename": "Mandos",

3049

"use_dbus": "True",

3050

"use_ipv6": "True",

3051

"debuglevel": "",

3052

"restore": "True",

3053

"socket": "",

3054

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

3055

"foreground": "False",

3056

"zeroconf": "True",

3057

}

3058

del priority

3059

2176

server_defaults = { "interface": "",

2177

"address": "",

2178

"port": "",

2179

"debug": "False",

2180

"priority":

2181

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

2182

"servicename": "Mandos",

2183

"use_dbus": "True",

2184

"use_ipv6": "True",

2185

"debuglevel": "",

2186

"restore": "True",

2187

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

2188

}

2189

3060

2190

# Parse config file for server-global settings

3061

server_config = configparser.ConfigParser(server_defaults)

2191

server_config = configparser.SafeConfigParser(server_defaults)

3062

2192

del server_defaults

3063

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

3064

# Convert the ConfigParser object to a dict

2193

server_config.read(os.path.join(options.configdir,

2194

"mandos.conf"))

2195

# Convert the SafeConfigParser object to a dict

3065

2196

server_settings = server_config.defaults()

3066

2197

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

3067

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

3068

"foreground", "zeroconf"):

2198

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

3069

2199

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

3070

2200

option)

3071

2201

if server_settings["port"]:

3072

2202

server_settings["port"] = server_config.getint("DEFAULT",

3073

2203

"port")

3074

if server_settings["socket"]:

3075

server_settings["socket"] = server_config.getint("DEFAULT",

3076

"socket")

3077

# Later, stdin will, and stdout and stderr might, be dup'ed

3078

# over with an opened os.devnull. But we don't want this to

3079

# happen with a supplied network socket.

3080

if 0 <= server_settings["socket"] <= 2:

3081

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

3082

["socket"])

3083

2204

del server_config

3084

2205

3085

2206

# Override the settings from the config file with command line

3086

2207

# options, if set.

3087

2208

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

3088

"priority", "servicename", "configdir", "use_dbus",

3089

"use_ipv6", "debuglevel", "restore", "statedir",

3090

"socket", "foreground", "zeroconf"):

2209

"priority", "servicename", "configdir",

2210

"use_dbus", "use_ipv6", "debuglevel", "restore",

2211

"statedir"):

3091

2212

value = getattr(options, option)

3092

2213

if value is not None:

3093

2214

server_settings[option] = value

3094

2215

del options

3095

2216

# Force all strings to be unicode

3096

2217

for option in server_settings.keys():

3097

if isinstance(server_settings[option], bytes):

3098

server_settings[option] = (server_settings[option]

3099

.decode("utf-8"))

3100

# Force all boolean options to be boolean

3101

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

3102

"foreground", "zeroconf"):

3103

server_settings[option] = bool(server_settings[option])

3104

# Debug implies foreground

3105

if server_settings["debug"]:

3106

server_settings["foreground"] = True

2218

if type(server_settings[option]) is str:

2219

server_settings[option] = unicode(server_settings[option])

3107

2220

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

3108

2221

3109

2222

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

3110

3111

if (not server_settings["zeroconf"]

3112

and not (server_settings["port"]

3113

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

3114

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

3115

2223

3116

2224

# For convenience

3117

2225

debug = server_settings["debug"]

3118

2226

debuglevel = server_settings["debuglevel"]

3120

2228

use_ipv6 = server_settings["use_ipv6"]

3121

2229

stored_state_path = os.path.join(server_settings["statedir"],

3122

2230

stored_state_file)

3123

foreground = server_settings["foreground"]

3124

zeroconf = server_settings["zeroconf"]

3125

2231

3126

2232

if debug:

3127

2233

initlogger(debug, logging.DEBUG)

3128

2234

else:

3131

2237

else:

3132

2238

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

3133

2239

initlogger(debug, level)

3134

2240

3135

2241

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

3136

syslogger.setFormatter(

3137

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

3138

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

3139

server_settings["servicename"])))

3140

2242

syslogger.setFormatter(logging.Formatter

2243

('Mandos ({0}) [%(process)d]:'

2244

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

2245

.format(server_settings

2246

["servicename"])))

2247

3141

2248

# Parse config file with clients

3142

client_config = configparser.ConfigParser(Client.client_defaults)

2249

client_config = configparser.SafeConfigParser(Client

2250

.client_defaults)

3143

2251

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

3144

2252

"clients.conf"))

3145

2253

3146

2254

global mandos_dbus_service

3147

2255

mandos_dbus_service = None

3148

3149

socketfd = None

3150

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

3151

socketfd = server_settings["socket"]

3152

tcp_server = MandosServer(

3153

(server_settings["address"], server_settings["port"]),

3154

ClientHandler,

3155

interface=(server_settings["interface"] or None),

3156

use_ipv6=use_ipv6,

3157

gnutls_priority=server_settings["priority"],

3158

use_dbus=use_dbus,

3159

socketfd=socketfd)

3160

if not foreground:

3161

pidfilename = "/run/mandos.pid"

3162

if not os.path.isdir("/run/."):

3163

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

3164

pidfile = None

2256

2257

tcp_server = MandosServer((server_settings["address"],

2258

server_settings["port"]),

2259

ClientHandler,

2260

interface=(server_settings["interface"]

2261

or None),

2262

use_ipv6=use_ipv6,

2263

gnutls_priority=

2264

server_settings["priority"],

2265

use_dbus=use_dbus)

2266

if not debug:

2267

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

3165

2268

try:

3166

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

2269

pidfile = open(pidfilename, "w")

3167

2270

except IOError as e:

3168

2271

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

3169

2272

exc_info=e)

3170

3171

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

3172

("mandos", "mandos"),

3173

("nobody", "nogroup")):

2273

2274

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

3174

2275

try:

3175

2276

uid = pwd.getpwnam(name).pw_uid

3176

gid = pwd.getpwnam(group).pw_gid

2277

gid = pwd.getpwnam(name).pw_gid

3177

2278

break

3178

2279

except KeyError:

3179

2280

continue

3183

2284

try:

3184

2285

os.setgid(gid)

3185

2286

os.setuid(uid)

3186

if debug:

3187

logger.debug("Did setuid/setgid to {}:{}".format(uid,

3188

gid))

3189

2287

except OSError as error:

3190

logger.warning("Failed to setuid/setgid to {}:{}: {}"

3191

.format(uid, gid, os.strerror(error.errno)))

3192

if error.errno != errno.EPERM:

3193

raise

3194

2288

if error[0] != errno.EPERM:

2289

raise error

2290

3195

2291

if debug:

3196

2292

# Enable all possible GnuTLS debugging

3197

2293

3198

2294

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

3199

2295

# - GnuTLS manual

3200

gnutls.global_set_log_level(11)

3201

3202

@gnutls.log_func

2296

gnutls.library.functions.gnutls_global_set_log_level(11)

2297

2298

@gnutls.library.types.gnutls_log_func

3203

2299

def debug_gnutls(level, string):

3204

logger.debug("GnuTLS: %s",

3205

string[:-1].decode("utf-8",

3206

errors="replace"))

3207

3208

gnutls.global_set_log_function(debug_gnutls)

3209

2300

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

2301

2302

(gnutls.library.functions

2303

.gnutls_global_set_log_function(debug_gnutls))

2304

3210

2305

# Redirect stdin so all checkers get /dev/null

3211

2306

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

3212

2307

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

3213

2308

if null > 2:

3214

2309

os.close(null)

3215

2310

3216

2311

# Need to fork before connecting to D-Bus

3217

if not foreground:

2312

if not debug:

3218

2313

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

3219

2314

daemon()

3220

3221

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

3222

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

3223

# need to inform GLib that threads will be used.

3224

GLib.threads_init()

3225

2315

2316

gobject.threads_init()

2317

3226

2318

global main_loop

3227

2319

# From the Avahi example code

3228

2320

DBusGMainLoop(set_as_default=True)

3229

main_loop = GLib.MainLoop()

2321

main_loop = gobject.MainLoop()

3230

2322

bus = dbus.SystemBus()

3231

2323

# End of Avahi example code

3232

2324

if use_dbus:

3233

2325

try:

3234

2326

bus_name = dbus.service.BusName("se.recompile.Mandos",

3235

bus,

3236

do_not_queue=True)

3237

old_bus_name = dbus.service.BusName(

3238

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

3239

do_not_queue=True)

3240

except dbus.exceptions.DBusException as e:

2327

bus, do_not_queue=True)

2328

old_bus_name = (dbus.service.BusName

2329

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

2330

do_not_queue=True))

2331

except dbus.exceptions.NameExistsException as e:

3241

2332

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

3242

2333

use_dbus = False

3243

2334

server_settings["use_dbus"] = False

3244

2335

tcp_server.use_dbus = False

3245

if zeroconf:

3246

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3247

service = AvahiServiceToSyslog(

3248

name=server_settings["servicename"],

3249

servicetype="_mandos._tcp",

3250

protocol=protocol,

3251

bus=bus)

3252

if server_settings["interface"]:

3253

service.interface = if_nametoindex(

3254

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

3255

2336

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2337

service = AvahiServiceToSyslog(name =

2338

server_settings["servicename"],

2339

servicetype = "_mandos._tcp",

2340

protocol = protocol, bus = bus)

2341

if server_settings["interface"]:

2342

service.interface = (if_nametoindex

2343

(str(server_settings["interface"])))

2344

3256

2345

global multiprocessing_manager

3257

2346

multiprocessing_manager = multiprocessing.Manager()

3258

2347

3259

2348

client_class = Client

3260

2349

if use_dbus:

3261

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

3262

2350

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

2351

3263

2352

client_settings = Client.config_parser(client_config)

3264

2353

old_client_settings = {}

3265

2354

clients_data = {}

3266

3267

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

3268

global wnull

3269

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

3270

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

3271

# mode

3272

if debug or not foreground:

3273

wnull.close()

3274

2355

3275

2356

# Get client data and settings from last running state.

3276

2357

if server_settings["restore"]:

3277

2358

try:

3278

2359

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

3279

if sys.version_info.major == 2:

3280

clients_data, old_client_settings = pickle.load(

3281

stored_state)

3282

else:

3283

bytes_clients_data, bytes_old_client_settings = (

3284

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

3285

# Fix bytes to strings

3286

# clients_data

3287

# .keys()

3288

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

3289

if isinstance(key, bytes)

3290

else key): value

3291

for key, value in

3292

bytes_clients_data.items()}

3293

del bytes_clients_data

3294

for key in clients_data:

3295

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

3296

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

3297

for k, v in

3298

clients_data[key].items()}

3299

clients_data[key] = value

3300

# .client_structure

3301

value["client_structure"] = [

3302

(s.decode("utf-8")

3303

if isinstance(s, bytes)

3304

else s) for s in

3305

value["client_structure"]]

3306

# .name, .host, and .checker_command

3307

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

3308

if isinstance(value[k], bytes):

3309

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

3310

if "key_id" not in value:

3311

value["key_id"] = ""

3312

elif "fingerprint" not in value:

3313

value["fingerprint"] = ""

3314

# old_client_settings

3315

# .keys()

3316

old_client_settings = {

3317

(key.decode("utf-8")

3318

if isinstance(key, bytes)

3319

else key): value

3320

for key, value in

3321

bytes_old_client_settings.items()}

3322

del bytes_old_client_settings

3323

# .host and .checker_command

3324

for value in old_client_settings.values():

3325

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

3326

if isinstance(value[attribute], bytes):

3327

value[attribute] = (value[attribute]

3328

.decode("utf-8"))

2360

clients_data, old_client_settings = (pickle.load

2361

(stored_state))

3329

2362

os.remove(stored_state_path)

3330

2363

except IOError as e:

3331

2364

if e.errno == errno.ENOENT:

3332

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

3333

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

2365

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

2366

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

3334

2367

else:

3335

2368

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

3336

2369

exc_info=e)

3337

2370

raise

3338

2371

except EOFError as e:

3339

2372

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

3340

"EOFError:",

3341

exc_info=e)

3342

2373

"EOFError:", exc_info=e)

2374

3343

2375

with PGPEngine() as pgp:

3344

for client_name, client in clients_data.items():

3345

# Skip removed clients

3346

if client_name not in client_settings:

3347

continue

3348

2376

for client_name, client in clients_data.iteritems():

3349

2377

# Decide which value to use after restoring saved state.

3350

2378

# We have three different values: Old config file,

3351

2379

# new config file, and saved state.

3356

2384

# For each value in new config, check if it

3357

2385

# differs from the old config value (Except for

3358

2386

# the "secret" attribute)

3359

if (name != "secret"

3360

and (value !=

3361

old_client_settings[client_name][name])):

2387

if (name != "secret" and

2388

value != old_client_settings[client_name]

2389

[name]):

3362

2390

client[name] = value

3363

2391

except KeyError:

3364

2392

pass

3365

2393

3366

2394

# Clients who has passed its expire date can still be

3367

# enabled if its last checker was successful. A Client

2395

# enabled if its last checker was successful. Clients

3368

2396

# whose checker succeeded before we stored its state is

3369

2397

# assumed to have successfully run all checkers during

3370

2398

# downtime.

3372

2400

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

3373

2401

if not client["last_checked_ok"]:

3374

2402

logger.warning(

3375

"disabling client {} - Client never "

3376

"performed a successful checker".format(

3377

client_name))

2403

"disabling client {0} - Client never "

2404

"performed a successful checker"

2405

.format(client_name))

3378

2406

client["enabled"] = False

3379

2407

elif client["last_checker_status"] != 0:

3380

2408

logger.warning(

3381

"disabling client {} - Client last"

3382

" checker failed with error code"

3383

" {}".format(

3384

client_name,

3385

client["last_checker_status"]))

2409

"disabling client {0} - Client "

2410

"last checker failed with error code {1}"

2411

.format(client_name,

2412

client["last_checker_status"]))

3386

2413

client["enabled"] = False

3387

2414

else:

3388

client["expires"] = (

3389

datetime.datetime.utcnow()

3390

+ client["timeout"])

2415

client["expires"] = (datetime.datetime

2416

.utcnow()

2417

+ client["timeout"])

3391

2418

logger.debug("Last checker succeeded,"

3392

" keeping {} enabled".format(

3393

client_name))

2419

" keeping {0} enabled"

2420

.format(client_name))

3394

2421

try:

3395

client["secret"] = pgp.decrypt(

3396

client["encrypted_secret"],

3397

client_settings[client_name]["secret"])

2422

client["secret"] = (

2423

pgp.decrypt(client["encrypted_secret"],

2424

client_settings[client_name]

2425

["secret"]))

3398

2426

except PGPError:

3399

2427

# If decryption fails, we use secret from new settings

3400

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

3401

client_name))

3402

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

3403

["secret"])

3404

2428

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

2429

.format(client_name))

2430

client["secret"] = (

2431

client_settings[client_name]["secret"])

2432

3405

2433

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

3406

2434

for client_name in (set(old_client_settings)

3407

2435

- set(client_settings)):

3409

2437

for client_name in (set(client_settings)

3410

2438

- set(old_client_settings)):

3411

2439

clients_data[client_name] = client_settings[client_name]

3412

2440

3413

2441

# Create all client objects

3414

for client_name, client in clients_data.items():

2442

for client_name, client in clients_data.iteritems():

3415

2443

tcp_server.clients[client_name] = client_class(

3416

name=client_name,

3417

settings=client,

3418

server_settings=server_settings)

3419

2444

name = client_name, settings = client)

2445

3420

2446

if not tcp_server.clients:

3421

2447

logger.warning("No clients defined")

3422

3423

if not foreground:

3424

if pidfile is not None:

3425

pid = os.getpid()

3426

try:

3427

with pidfile:

3428

print(pid, file=pidfile)

3429

except IOError:

3430

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

3431

pidfilename, pid)

3432

del pidfile

2448

2449

if not debug:

2450

try:

2451

with pidfile:

2452

pid = os.getpid()

2453

pidfile.write(str(pid) + "\n".encode("utf-8"))

2454

del pidfile

2455

except IOError:

2456

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

2457

pidfilename, pid)

2458

except NameError:

2459

# "pidfile" was never created

2460

pass

3433

2461

del pidfilename

3434

3435

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

3436

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3437

lambda: main_loop.quit() and False)

3438

2462

signal.signal(signal.SIGINT, signal.SIG_IGN)

2463

2464

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

2465

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

2466

3439

2467

if use_dbus:

3440

3441

@alternate_dbus_interfaces(

3442

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

3443

class MandosDBusService(DBusObjectWithObjectManager):

2468

@alternate_dbus_interfaces({"se.recompile.Mandos":

2469

"se.bsnet.fukt.Mandos"})

2470

class MandosDBusService(DBusObjectWithProperties):

3444

2471

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

3445

3446

2472

def __init__(self):

3447

2473

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

3448

3449

2474

_interface = "se.recompile.Mandos"

3450

2475

2476

@dbus_interface_annotations(_interface)

2477

def _foo(self):

2478

return { "org.freedesktop.DBus.Property"

2479

".EmitsChangedSignal":

2480

"false"}

2481

3451

2482

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

3452

2483

def ClientAdded(self, objpath):

3453

2484

"D-Bus signal"

3454

2485

pass

3455

2486

3456

2487

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

3457

def ClientNotFound(self, key_id, address):

2488

def ClientNotFound(self, fingerprint, address):

3458

2489

"D-Bus signal"

3459

2490

pass

3460

3461

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

3462

"true"})

2491

3463

2492

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

3464

2493

def ClientRemoved(self, objpath, name):

3465

2494

"D-Bus signal"

3466

2495

pass

3467

3468

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

3469

"true"})

2496

3470

2497

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

3471

2498

def GetAllClients(self):

3472

2499

"D-Bus method"

3473

return dbus.Array(c.dbus_object_path for c in

3474

tcp_server.clients.values())

3475

3476

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

3477

"true"})

2500

return dbus.Array(c.dbus_object_path

2501

for c in

2502

tcp_server.clients.itervalues())

2503

3478

2504

@dbus.service.method(_interface,

3479

2505

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

3480

2506

def GetAllClientsWithProperties(self):

3481

2507

"D-Bus method"

3482

2508

return dbus.Dictionary(

3483

{c.dbus_object_path: c.GetAll(

3484

"se.recompile.Mandos.Client")

3485

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

2509

((c.dbus_object_path, c.GetAll(""))

2510

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

3486

2511

signature="oa{sv}")

3487

2512

3488

2513

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

3489

2514

def RemoveClient(self, object_path):

3490

2515

"D-Bus method"

3491

for c in tcp_server.clients.values():

2516

for c in tcp_server.clients.itervalues():

3492

2517

if c.dbus_object_path == object_path:

3493

2518

del tcp_server.clients[c.name]

3494

2519

c.remove_from_connection()

3495

# Don't signal the disabling

2520

# Don't signal anything except ClientRemoved

3496

2521

c.disable(quiet=True)

3497

# Emit D-Bus signal for removal

3498

self.client_removed_signal(c)

2522

# Emit D-Bus signal

2523

self.ClientRemoved(object_path, c.name)

3499

2524

return

3500

2525

raise KeyError(object_path)

3501

2526

3502

2527

del _interface

3503

3504

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3505

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

3506

def GetManagedObjects(self):

3507

"""D-Bus method"""

3508

return dbus.Dictionary(

3509

{client.dbus_object_path:

3510

dbus.Dictionary(

3511

{interface: client.GetAll(interface)

3512

for interface in

3513

client._get_all_interface_names()})

3514

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

3515

3516

def client_added_signal(self, client):

3517

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

3518

if use_dbus:

3519

# New standard signal

3520

self.InterfacesAdded(

3521

client.dbus_object_path,

3522

dbus.Dictionary(

3523

{interface: client.GetAll(interface)

3524

for interface in

3525

client._get_all_interface_names()}))

3526

# Old signal

3527

self.ClientAdded(client.dbus_object_path)

3528

3529

def client_removed_signal(self, client):

3530

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

3531

if use_dbus:

3532

# New standard signal

3533

self.InterfacesRemoved(

3534

client.dbus_object_path,

3535

client._get_all_interface_names())

3536

# Old signal

3537

self.ClientRemoved(client.dbus_object_path,

3538

client.name)

3539

2528

3540

2529

mandos_dbus_service = MandosDBusService()

3541

3542

# Save modules to variables to exempt the modules from being

3543

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

3544

mp = multiprocessing

3545

wn = wnull

3546

2530

3547

2531

def cleanup():

3548

2532

"Cleanup function; run on exit"

3549

if zeroconf:

3550

service.cleanup()

3551

3552

mp.active_children()

3553

wn.close()

2533

service.cleanup()

2534

2535

multiprocessing.active_children()

3554

2536

if not (tcp_server.clients or client_settings):

3555

2537

return

3556

2538

3557

2539

# Store client before exiting. Secrets are encrypted with key

3558

2540

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

3559

2541

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

3560

2542

clients = {}

3561

2543

with PGPEngine() as pgp:

3562

for client in tcp_server.clients.values():

2544

for client in tcp_server.clients.itervalues():

3563

2545

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

3564

2546

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

3565

2547

key)

3566

2548

client_dict = {}

3567

2549

3568

2550

# A list of attributes that can not be pickled

3569

2551

# + secret.

3570

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

3571

"checker", "server_settings"}

3572

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

3573

.Object):

2552

exclude = set(("bus", "changedstate", "secret",

2553

"checker"))

2554

for name, typ in (inspect.getmembers

2555

(dbus.service.Object)):

3574

2556

exclude.add(name)

3575

2557

3576

2558

client_dict["encrypted_secret"] = (client

3577

2559

.encrypted_secret)

3578

2560

for attr in client.client_structure:

3579

2561

if attr not in exclude:

3580

2562

client_dict[attr] = getattr(client, attr)

3581

2563

3582

2564

clients[client.name] = client_dict

3583

2565

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

3584

2566

3585

2567

try:

3586

with tempfile.NamedTemporaryFile(

3587

mode="wb",

3588

suffix=".pickle",

3589

prefix="clients-",

3590

dir=os.path.dirname(stored_state_path),

3591

delete=False) as stored_state:

3592

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

3593

protocol=2)

3594

tempname = stored_state.name

2568

with (tempfile.NamedTemporaryFile

2569

(mode='wb', suffix=".pickle", prefix='clients-',

2570

dir=os.path.dirname(stored_state_path),

2571

delete=False)) as stored_state:

2572

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

2573

tempname=stored_state.name

3595

2574

os.rename(tempname, stored_state_path)

3596

2575

except (IOError, OSError) as e:

3597

2576

if not debug:

3600

2579

except NameError:

3601

2580

pass

3602

2581

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

3603

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

2582

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

3604

2583

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

3605

2584

else:

3606

2585

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

3607

2586

exc_info=e)

3608

raise

3609

2587

raise e

2588

3610

2589

# Delete all clients, and settings from config

3611

2590

while tcp_server.clients:

3612

2591

name, client = tcp_server.clients.popitem()

3613

2592

if use_dbus:

3614

2593

client.remove_from_connection()

3615

# Don't signal the disabling

2594

# Don't signal anything except ClientRemoved

3616

2595

client.disable(quiet=True)

3617

# Emit D-Bus signal for removal

3618

2596

if use_dbus:

3619

mandos_dbus_service.client_removed_signal(client)

2597

# Emit D-Bus signal

2598

mandos_dbus_service.ClientRemoved(client

2599

.dbus_object_path,

2600

client.name)

3620

2601

client_settings.clear()

3621

2602

3622

2603

atexit.register(cleanup)

3623

3624

for client in tcp_server.clients.values():

2604

2605

for client in tcp_server.clients.itervalues():

3625

2606

if use_dbus:

3626

# Emit D-Bus signal for adding

3627

mandos_dbus_service.client_added_signal(client)

2607

# Emit D-Bus signal

2608

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3628

2609

# Need to initiate checking of clients

3629

2610

if client.enabled:

3630

2611

client.init_checker()

3631

2612

3632

2613

tcp_server.enable()

3633

2614

tcp_server.server_activate()

3634

2615

3635

2616

# Find out what port we got

3636

if zeroconf:

3637

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

2617

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

3638

2618

if use_ipv6:

3639

2619

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

3640

2620

" flowinfo %d, scope_id %d",

3642

2622

else: # IPv4

3643

2623

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

3644

2624

*tcp_server.socket.getsockname())

3645

3646

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

3647

2625

2626

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

2627

3648

2628

try:

3649

if zeroconf:

3650

# From the Avahi example code

3651

try:

3652

service.activate()

3653

except dbus.exceptions.DBusException as error:

3654

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

3655

cleanup()

3656

sys.exit(1)

3657

# End of Avahi example code

3658

3659

GLib.io_add_watch(

3660

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

3661

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3662

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

3663

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

3664

2629

# From the Avahi example code

2630

try:

2631

service.activate()

2632

except dbus.exceptions.DBusException as error:

2633

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

2634

cleanup()

2635

sys.exit(1)

2636

# End of Avahi example code

2637

2638

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

2639

lambda *args, **kwargs:

2640

(tcp_server.handle_request

2641

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

2642

3665

2643

logger.debug("Starting main loop")

3666

2644

main_loop.run()

3667

2645

except AvahiError as error:

3676

2654

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

3677

2655

cleanup()

3678

2656

3679

3680

def should_only_run_tests():

3681

parser = argparse.ArgumentParser(add_help=False)

3682

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

3683

args, unknown_args = parser.parse_known_args()

3684

run_tests = args.check

3685

if run_tests:

3686

# Remove --check argument from sys.argv

3687

sys.argv[1:] = unknown_args

3688

return run_tests

3689

3690

# Add all tests from doctest strings

3691

def load_tests(loader, tests, none):

3692

import doctest

3693

tests.addTests(doctest.DocTestSuite())

3694

return tests

3695

3696

if __name__ == "__main__":

3697

try:

3698

if should_only_run_tests():

3699

# Call using ./mandos --check [--verbose]

3700

unittest.main()

3701

else:

3702

main()

3703

finally:

3704

logging.shutdown()

2657

if __name__ == '__main__':

2658

main()