/mandos/release : revision 237.7.305

1

#!/usr/bin/python

1

#!/usr/bin/python2.7

2

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

3

#

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

39

try:

44

40

import SocketServer as socketserver

48

44

import argparse

49

45

import datetime

50

46

import errno

47

import gnutls.crypto

48

import gnutls.connection

49

import gnutls.errors

50

import gnutls.library.functions

51

import gnutls.library.constants

52

import gnutls.library.types

51

53

try:

52

54

import ConfigParser as configparser

53

55

except ImportError:

80

82

81

83

import dbus

82

84

import dbus.service

83

from gi.repository import GLib

85

try:

86

import gobject

87

except ImportError:

88

from gi.repository import GObject as gobject

89

import avahi

84

90

from dbus.mainloop.glib import DBusGMainLoop

85

91

import ctypes

86

92

import ctypes.util

87

93

import xml.dom.minidom

88

94

import inspect

89

95

90

# Try to find the value of SO_BINDTODEVICE:

91

96

try:

92

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

93

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

94

97

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

95

98

except AttributeError:

96

99

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

99

100

from IN import SO_BINDTODEVICE

100

101

except ImportError:

101

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

102

# Try running the C preprocessor:

103

try:

104

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

105

"/dev/stdin"],

106

stdin=subprocess.PIPE,

107

stdout=subprocess.PIPE)

108

stdout = cc.communicate(

109

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

110

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

111

except (OSError, ValueError, IndexError):

112

# No value found

113

SO_BINDTODEVICE = None

102

SO_BINDTODEVICE = None

114

103

115

104

if sys.version_info.major == 2:

116

105

str = unicode

117

106

118

version = "1.7.16"

107

version = "1.6.9"

119

108

stored_state_file = "clients.pickle"

120

109

121

110

logger = logging.getLogger()

125

114

if_nametoindex = ctypes.cdll.LoadLibrary(

126

115

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

127

116

except (OSError, AttributeError):

128

117

129

118

def if_nametoindex(interface):

130

119

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

131

120

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

136

125

return interface_index

137

126

138

127

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

155

128

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

156

129

"""init logger and add loglevel"""

157

130

158

131

global syslogger

159

132

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

133

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

134

address = "/dev/log"))

162

135

syslogger.setFormatter(logging.Formatter

163

136

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

164

137

' %(message)s'))

165

138

logger.addHandler(syslogger)

166

139

167

140

if debug:

168

141

console = logging.StreamHandler()

169

142

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

181

154

182

155

class PGPEngine(object):

183

156

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

184

157

185

158

def __init__(self):

186

159

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

187

self.gpg = "gpg"

188

try:

189

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

190

for line in output.splitlines():

191

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

192

if name == "gpg":

193

self.gpg = path

194

break

195

except OSError as e:

196

if e.errno != errno.ENOENT:

197

raise

198

160

self.gnupgargs = ['--batch',

199

'--homedir', self.tempdir,

161

'--home', self.tempdir,

200

162

'--force-mdc',

201

'--quiet']

202

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

203

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

204

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

205

163

'--quiet',

164

'--no-use-agent']

165

206

166

def __enter__(self):

207

167

return self

208

168

209

169

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

210

170

self._cleanup()

211

171

return False

212

172

213

173

def __del__(self):

214

174

self._cleanup()

215

175

216

176

def _cleanup(self):

217

177

if self.tempdir is not None:

218

178

# Delete contents of tempdir

219

179

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

220

topdown=False):

180

topdown = False):

221

181

for filename in files:

222

182

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

223

183

for dirname in dirs:

225

185

# Remove tempdir

226

186

os.rmdir(self.tempdir)

227

187

self.tempdir = None

228

188

229

189

def password_encode(self, password):

230

190

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

231

191

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

236

196

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

237

197

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

238

198

return encoded

239

199

240

200

def encrypt(self, data, password):

241

201

passphrase = self.password_encode(password)

242

202

with tempfile.NamedTemporaryFile(

243

203

dir=self.tempdir) as passfile:

244

204

passfile.write(passphrase)

245

205

passfile.flush()

246

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

206

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

247

207

'--passphrase-file',

248

208

passfile.name]

249

209

+ self.gnupgargs,

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

210

stdin = subprocess.PIPE,

211

stdout = subprocess.PIPE,

212

stderr = subprocess.PIPE)

213

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

254

214

if proc.returncode != 0:

255

215

raise PGPError(err)

256

216

return ciphertext

257

217

258

218

def decrypt(self, data, password):

259

219

passphrase = self.password_encode(password)

260

220

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

221

dir = self.tempdir) as passfile:

262

222

passfile.write(passphrase)

263

223

passfile.flush()

264

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

224

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

265

225

'--passphrase-file',

266

226

passfile.name]

267

227

+ self.gnupgargs,

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

228

stdin = subprocess.PIPE,

229

stdout = subprocess.PIPE,

230

stderr = subprocess.PIPE)

231

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

272

232

if proc.returncode != 0:

273

233

raise PGPError(err)

274

234

return decrypted_plaintext

275

235

276

236

277

# Pretend that we have an Avahi module

278

class Avahi(object):

279

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

280

It is instantiated once, and simulates having an Avahi module."""

281

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

282

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

283

PROTO_INET = 0 # avahi-common/address.h

284

PROTO_INET6 = 1 # avahi-common/address.h

285

DBUS_NAME = "org.freedesktop.Avahi"

286

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

287

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

288

DBUS_PATH_SERVER = "/"

289

290

def string_array_to_txt_array(self, t):

291

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

292

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

293

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

294

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

295

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

296

SERVER_INVALID = 0 # avahi-common/defs.h

297

SERVER_REGISTERING = 1 # avahi-common/defs.h

298

SERVER_RUNNING = 2 # avahi-common/defs.h

299

SERVER_COLLISION = 3 # avahi-common/defs.h

300

SERVER_FAILURE = 4 # avahi-common/defs.h

301

avahi = Avahi()

302

303

304

237

class AvahiError(Exception):

305

238

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

306

239

self.value = value

318

251

319

252

class AvahiService(object):

320

253

"""An Avahi (Zeroconf) service.

321

254

322

255

Attributes:

323

256

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

324

257

Used to optionally bind to the specified interface.

336

269

server: D-Bus Server

337

270

bus: dbus.SystemBus()

338

271

"""

339

272

340

273

def __init__(self,

341

interface=avahi.IF_UNSPEC,

342

name=None,

343

servicetype=None,

344

port=None,

345

TXT=None,

346

domain="",

347

host="",

348

max_renames=32768,

349

protocol=avahi.PROTO_UNSPEC,

350

bus=None):

274

interface = avahi.IF_UNSPEC,

275

name = None,

276

servicetype = None,

277

port = None,

278

TXT = None,

279

domain = "",

280

host = "",

281

max_renames = 32768,

282

protocol = avahi.PROTO_UNSPEC,

283

bus = None):

351

284

self.interface = interface

352

285

self.name = name

353

286

self.type = servicetype

362

295

self.server = None

363

296

self.bus = bus

364

297

self.entry_group_state_changed_match = None

365

298

366

299

def rename(self, remove=True):

367

300

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

368

301

if self.rename_count >= self.max_renames:

388

321

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

389

322

self.cleanup()

390

323

os._exit(1)

391

324

392

325

def remove(self):

393

326

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

394

327

if self.entry_group_state_changed_match is not None:

396

329

self.entry_group_state_changed_match = None

397

330

if self.group is not None:

398

331

self.group.Reset()

399

332

400

333

def add(self):

401

334

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

402

335

self.remove()

419

352

dbus.UInt16(self.port),

420

353

avahi.string_array_to_txt_array(self.TXT))

421

354

self.group.Commit()

422

355

423

356

def entry_group_state_changed(self, state, error):

424

357

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

425

358

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

426

359

427

360

if state == avahi.ENTRY_GROUP_ESTABLISHED:

428

361

logger.debug("Zeroconf service established.")

429

362

elif state == avahi.ENTRY_GROUP_COLLISION:

433

366

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

434

367

str(error))

435

368

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

436

369

437

370

def cleanup(self):

438

371

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

439

372

if self.group is not None:

444

377

pass

445

378

self.group = None

446

379

self.remove()

447

380

448

381

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

449

382

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

450

383

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

462

395

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

463

396

self.cleanup()

464

397

elif state == avahi.SERVER_RUNNING:

465

try:

466

self.add()

467

except dbus.exceptions.DBusException as error:

468

if (error.get_dbus_name()

469

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

470

logger.info("Local Zeroconf service name"

471

" collision.")

472

return self.rename(remove=False)

473

else:

474

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

475

self.cleanup()

476

os._exit(1)

398

self.add()

477

399

else:

478

400

if error is None:

479

401

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

480

402

else:

481

403

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

482

404

483

405

def activate(self):

484

406

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

485

407

if self.server is None:

496

418

class AvahiServiceToSyslog(AvahiService):

497

419

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

498

420

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

499

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

500

**kwargs)

421

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

501

422

syslogger.setFormatter(logging.Formatter(

502

423

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

503

424

.format(self.name)))

504

425

return ret

505

426

506

507

# Pretend that we have a GnuTLS module

508

class GnuTLS(object):

509

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

510

It is instantiated once, and simulates having a GnuTLS module."""

511

512

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

513

if library is None:

514

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

515

_library = ctypes.cdll.LoadLibrary(library)

516

del library

517

_need_version = b"3.3.0"

518

519

def __init__(self):

520

# Need to use "self" here, since this method is called before

521

# the assignment to the "gnutls" global variable happens.

522

if self.check_version(self._need_version) is None:

523

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

524

.format(self._need_version))

525

526

# Unless otherwise indicated, the constants and types below are

527

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

528

529

# Constants

530

E_SUCCESS = 0

531

E_INTERRUPTED = -52

532

E_AGAIN = -28

533

CRT_OPENPGP = 2

534

CLIENT = 2

535

SHUT_RDWR = 0

536

CRD_CERTIFICATE = 1

537

E_NO_CERTIFICATE_FOUND = -49

538

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

539

540

# Types

541

class session_int(ctypes.Structure):

542

_fields_ = []

543

session_t = ctypes.POINTER(session_int)

544

545

class certificate_credentials_st(ctypes.Structure):

546

_fields_ = []

547

certificate_credentials_t = ctypes.POINTER(

548

certificate_credentials_st)

549

certificate_type_t = ctypes.c_int

550

551

class datum_t(ctypes.Structure):

552

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

553

('size', ctypes.c_uint)]

554

555

class openpgp_crt_int(ctypes.Structure):

556

_fields_ = []

557

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

558

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

559

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

560

credentials_type_t = ctypes.c_int

561

transport_ptr_t = ctypes.c_void_p

562

close_request_t = ctypes.c_int

563

564

# Exceptions

565

class Error(Exception):

566

# We need to use the class name "GnuTLS" here, since this

567

# exception might be raised from within GnuTLS.__init__,

568

# which is called before the assignment to the "gnutls"

569

# global variable has happened.

570

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

571

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

572

# code is passed, convert it to a string with

573

# gnutls.strerror()

574

self.code = code

575

if message is None and code is not None:

576

message = GnuTLS.strerror(code)

577

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

578

message, *args)

579

580

class CertificateSecurityError(Error):

581

pass

582

583

# Classes

584

class Credentials(object):

585

def __init__(self):

586

self._c_object = gnutls.certificate_credentials_t()

587

gnutls.certificate_allocate_credentials(

588

ctypes.byref(self._c_object))

589

self.type = gnutls.CRD_CERTIFICATE

590

591

def __del__(self):

592

gnutls.certificate_free_credentials(self._c_object)

593

594

class ClientSession(object):

595

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

596

self._c_object = gnutls.session_t()

597

gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)

598

gnutls.set_default_priority(self._c_object)

599

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

600

gnutls.handshake_set_private_extensions(self._c_object,

601

True)

602

self.socket = socket

603

if credentials is None:

604

credentials = gnutls.Credentials()

605

gnutls.credentials_set(self._c_object, credentials.type,

606

ctypes.cast(credentials._c_object,

607

ctypes.c_void_p))

608

self.credentials = credentials

609

610

def __del__(self):

611

gnutls.deinit(self._c_object)

612

613

def handshake(self):

614

return gnutls.handshake(self._c_object)

615

616

def send(self, data):

617

data = bytes(data)

618

data_len = len(data)

619

while data_len > 0:

620

data_len -= gnutls.record_send(self._c_object,

621

data[-data_len:],

622

data_len)

623

624

def bye(self):

625

return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)

626

627

# Error handling functions

628

def _error_code(result):

629

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

630

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

631

if result >= 0:

632

return result

633

if result == gnutls.E_NO_CERTIFICATE_FOUND:

634

raise gnutls.CertificateSecurityError(code=result)

635

raise gnutls.Error(code=result)

636

637

def _retry_on_error(result, func, arguments):

638

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

639

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

640

while result < 0:

641

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

642

return _error_code(result)

643

result = func(*arguments)

644

return result

645

646

# Unless otherwise indicated, the function declarations below are

647

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

648

649

# Functions

650

priority_set_direct = _library.gnutls_priority_set_direct

651

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

652

ctypes.POINTER(ctypes.c_char_p)]

653

priority_set_direct.restype = _error_code

654

655

init = _library.gnutls_init

656

init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]

657

init.restype = _error_code

658

659

set_default_priority = _library.gnutls_set_default_priority

660

set_default_priority.argtypes = [session_t]

661

set_default_priority.restype = _error_code

662

663

record_send = _library.gnutls_record_send

664

record_send.argtypes = [session_t, ctypes.c_void_p,

665

ctypes.c_size_t]

666

record_send.restype = ctypes.c_ssize_t

667

record_send.errcheck = _retry_on_error

668

669

certificate_allocate_credentials = (

670

_library.gnutls_certificate_allocate_credentials)

671

certificate_allocate_credentials.argtypes = [

672

ctypes.POINTER(certificate_credentials_t)]

673

certificate_allocate_credentials.restype = _error_code

674

675

certificate_free_credentials = (

676

_library.gnutls_certificate_free_credentials)

677

certificate_free_credentials.argtypes = [

678

certificate_credentials_t]

679

certificate_free_credentials.restype = None

680

681

handshake_set_private_extensions = (

682

_library.gnutls_handshake_set_private_extensions)

683

handshake_set_private_extensions.argtypes = [session_t,

684

ctypes.c_int]

685

handshake_set_private_extensions.restype = None

686

687

credentials_set = _library.gnutls_credentials_set

688

credentials_set.argtypes = [session_t, credentials_type_t,

689

ctypes.c_void_p]

690

credentials_set.restype = _error_code

691

692

strerror = _library.gnutls_strerror

693

strerror.argtypes = [ctypes.c_int]

694

strerror.restype = ctypes.c_char_p

695

696

certificate_type_get = _library.gnutls_certificate_type_get

697

certificate_type_get.argtypes = [session_t]

698

certificate_type_get.restype = _error_code

699

700

certificate_get_peers = _library.gnutls_certificate_get_peers

701

certificate_get_peers.argtypes = [session_t,

702

ctypes.POINTER(ctypes.c_uint)]

703

certificate_get_peers.restype = ctypes.POINTER(datum_t)

704

705

global_set_log_level = _library.gnutls_global_set_log_level

706

global_set_log_level.argtypes = [ctypes.c_int]

707

global_set_log_level.restype = None

708

709

global_set_log_function = _library.gnutls_global_set_log_function

710

global_set_log_function.argtypes = [log_func]

711

global_set_log_function.restype = None

712

713

deinit = _library.gnutls_deinit

714

deinit.argtypes = [session_t]

715

deinit.restype = None

716

717

handshake = _library.gnutls_handshake

718

handshake.argtypes = [session_t]

719

handshake.restype = _error_code

720

handshake.errcheck = _retry_on_error

721

722

transport_set_ptr = _library.gnutls_transport_set_ptr

723

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

724

transport_set_ptr.restype = None

725

726

bye = _library.gnutls_bye

727

bye.argtypes = [session_t, close_request_t]

728

bye.restype = _error_code

729

bye.errcheck = _retry_on_error

730

731

check_version = _library.gnutls_check_version

732

check_version.argtypes = [ctypes.c_char_p]

733

check_version.restype = ctypes.c_char_p

734

735

# All the function declarations below are from gnutls/openpgp.h

736

737

openpgp_crt_init = _library.gnutls_openpgp_crt_init

738

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

739

openpgp_crt_init.restype = _error_code

740

741

openpgp_crt_import = _library.gnutls_openpgp_crt_import

742

openpgp_crt_import.argtypes = [openpgp_crt_t,

743

ctypes.POINTER(datum_t),

744

openpgp_crt_fmt_t]

745

openpgp_crt_import.restype = _error_code

746

747

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

748

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

749

ctypes.POINTER(ctypes.c_uint)]

750

openpgp_crt_verify_self.restype = _error_code

751

752

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

753

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

754

openpgp_crt_deinit.restype = None

755

756

openpgp_crt_get_fingerprint = (

757

_library.gnutls_openpgp_crt_get_fingerprint)

758

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

759

ctypes.c_void_p,

760

ctypes.POINTER(

761

ctypes.c_size_t)]

762

openpgp_crt_get_fingerprint.restype = _error_code

763

764

# Remove non-public functions

765

del _error_code, _retry_on_error

766

# Create the global "gnutls" object, simulating a module

767

gnutls = GnuTLS()

768

769

770

427

def call_pipe(connection, # : multiprocessing.Connection

771

428

func, *args, **kwargs):

772

429

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

773

430

774

431

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

775

432

return value on the provided multiprocessing.Connection.

776

433

"""

777

434

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

778

435

connection.close()

779

436

780

781

437

class Client(object):

782

438

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

783

439

784

440

Attributes:

785

441

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

786

442

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

788

444

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

789

445

to see if the client lives.

790

446

'None' if no process is running.

791

checker_callback_tag: a GLib event source tag, or None

447

checker_callback_tag: a gobject event source tag, or None

792

448

checker_command: string; External command which is run to check

793

449

if client lives. %() expansions are done at

794

450

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

795

451

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

796

checker_initiator_tag: a GLib event source tag, or None

452

checker_initiator_tag: a gobject event source tag, or None

797

453

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

798

454

client_structure: Object describing what attributes a client has

799

455

and is used for storing the client at exit

800

456

current_checker_command: string; current running checker_command

801

disable_initiator_tag: a GLib event source tag, or None

457

disable_initiator_tag: a gobject event source tag, or None

802

458

enabled: bool()

803

459

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

804

460

uniquely identify the client

823

479

disabled, or None

824

480

server_settings: The server_settings dict from main()

825

481

"""

826

482

827

483

runtime_expansions = ("approval_delay", "approval_duration",

828

484

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

829

485

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

840

496

"approved_by_default": "True",

841

497

"enabled": "True",

842

498

}

843

499

844

500

@staticmethod

845

501

def config_parser(config):

846

502

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

853

509

for client_name in config.sections():

854

510

section = dict(config.items(client_name))

855

511

client = settings[client_name] = {}

856

512

857

513

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

858

514

# Reformat values from string types to Python types

859

515

client["approved_by_default"] = config.getboolean(

860

516

client_name, "approved_by_default")

861

517

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

862

518

"enabled")

863

519

864

520

# Uppercase and remove spaces from fingerprint for later

865

521

# comparison purposes with return value from the

866

522

# fingerprint() function

867

523

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

868

524

.replace(" ", ""))

869

525

if "secret" in section:

870

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

871

.encode("utf-8"),

872

"base64")

526

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

873

527

elif "secfile" in section:

874

528

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

875

529

(section["secfile"])),

890

544

client["last_approval_request"] = None

891

545

client["last_checked_ok"] = None

892

546

client["last_checker_status"] = -2

893

547

894

548

return settings

895

896

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

549

550

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

897

551

self.name = name

898

552

if server_settings is None:

899

553

server_settings = {}

901

555

# adding all client settings

902

556

for setting, value in settings.items():

903

557

setattr(self, setting, value)

904

558

905

559

if self.enabled:

906

560

if not hasattr(self, "last_enabled"):

907

561

self.last_enabled = datetime.datetime.utcnow()

911

565

else:

912

566

self.last_enabled = None

913

567

self.expires = None

914

568

915

569

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

916

570

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

917

571

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

918

572

datetime.datetime.utcnow())

919

573

920

574

# attributes specific for this server instance

921

575

self.checker = None

922

576

self.checker_initiator_tag = None

928

582

self.changedstate = multiprocessing_manager.Condition(

929

583

multiprocessing_manager.Lock())

930

584

self.client_structure = [attr

931

for attr in self.__dict__.keys()

585

for attr in self.__dict__.iterkeys()

932

586

if not attr.startswith("_")]

933

587

self.client_structure.append("client_structure")

934

588

935

589

for name, t in inspect.getmembers(

936

590

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

937

591

if not name.startswith("_"):

938

592

self.client_structure.append(name)

939

593

940

594

# Send notice to process children that client state has changed

941

595

def send_changedstate(self):

942

596

with self.changedstate:

943

597

self.changedstate.notify_all()

944

598

945

599

def enable(self):

946

600

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

947

601

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

952

606

self.last_enabled = datetime.datetime.utcnow()

953

607

self.init_checker()

954

608

self.send_changedstate()

955

609

956

610

def disable(self, quiet=True):

957

611

"""Disable this client."""

958

612

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

960

614

if not quiet:

961

615

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

962

616

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

963

GLib.source_remove(self.disable_initiator_tag)

617

gobject.source_remove(self.disable_initiator_tag)

964

618

self.disable_initiator_tag = None

965

619

self.expires = None

966

620

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

967

GLib.source_remove(self.checker_initiator_tag)

621

gobject.source_remove(self.checker_initiator_tag)

968

622

self.checker_initiator_tag = None

969

623

self.stop_checker()

970

624

self.enabled = False

971

625

if not quiet:

972

626

self.send_changedstate()

973

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

627

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

974

628

return False

975

629

976

630

def __del__(self):

977

631

self.disable()

978

632

979

633

def init_checker(self):

980

634

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

981

635

# and every interval from then on.

982

636

if self.checker_initiator_tag is not None:

983

GLib.source_remove(self.checker_initiator_tag)

984

self.checker_initiator_tag = GLib.timeout_add(

637

gobject.source_remove(self.checker_initiator_tag)

638

self.checker_initiator_tag = gobject.timeout_add(

985

639

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

986

640

self.start_checker)

987

641

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

988

642

if self.disable_initiator_tag is not None:

989

GLib.source_remove(self.disable_initiator_tag)

990

self.disable_initiator_tag = GLib.timeout_add(

643

gobject.source_remove(self.disable_initiator_tag)

644

self.disable_initiator_tag = gobject.timeout_add(

991

645

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

992

646

# Also start a new checker *right now*.

993

647

self.start_checker()

994

648

995

649

def checker_callback(self, source, condition, connection,

996

650

command):

997

651

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

1000

654

# Read return code from connection (see call_pipe)

1001

655

returncode = connection.recv()

1002

656

connection.close()

1003

657

1004

658

if returncode >= 0:

1005

659

self.last_checker_status = returncode

1006

660

self.last_checker_signal = None

1016

670

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

1017

671

vars(self))

1018

672

return False

1019

673

1020

674

def checked_ok(self):

1021

675

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

1022

676

self.last_checked_ok = datetime.datetime.utcnow()

1023

677

self.last_checker_status = 0

1024

678

self.last_checker_signal = None

1025

679

self.bump_timeout()

1026

680

1027

681

def bump_timeout(self, timeout=None):

1028

682

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

1029

683

if timeout is None:

1030

684

timeout = self.timeout

1031

685

if self.disable_initiator_tag is not None:

1032

GLib.source_remove(self.disable_initiator_tag)

686

gobject.source_remove(self.disable_initiator_tag)

1033

687

self.disable_initiator_tag = None

1034

688

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

1035

self.disable_initiator_tag = GLib.timeout_add(

689

self.disable_initiator_tag = gobject.timeout_add(

1036

690

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

1037

691

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

1038

692

1039

693

def need_approval(self):

1040

694

self.last_approval_request = datetime.datetime.utcnow()

1041

695

1042

696

def start_checker(self):

1043

697

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

1044

698

1045

699

If a checker already exists, leave it running and do

1046

700

nothing."""

1047

701

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

1052

706

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

1053

707

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

1054

708

# should be.

1055

709

1056

710

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

1057

711

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

1058

712

self.checker.join()

1062

716

# Escape attributes for the shell

1063

717

escaped_attrs = {

1064

718

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

1065

for attr in self.runtime_expansions}

719

for attr in self.runtime_expansions }

1066

720

try:

1067

721

command = self.checker_command % escaped_attrs

1068

722

except TypeError as error:

1080

734

# The exception is when not debugging but nevertheless

1081

735

# running in the foreground; use the previously

1082

736

# created wnull.

1083

popen_args = {"close_fds": True,

1084

"shell": True,

1085

"cwd": "/"}

737

popen_args = { "close_fds": True,

738

"shell": True,

739

"cwd": "/" }

1086

740

if (not self.server_settings["debug"]

1087

741

and self.server_settings["foreground"]):

1088

742

popen_args.update({"stdout": wnull,

1089

"stderr": wnull})

1090

pipe = multiprocessing.Pipe(duplex=False)

743

"stderr": wnull })

744

pipe = multiprocessing.Pipe(duplex = False)

1091

745

self.checker = multiprocessing.Process(

1092

target=call_pipe,

1093

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

1094

kwargs=popen_args)

746

target = call_pipe,

747

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

748

kwargs = popen_args)

1095

749

self.checker.start()

1096

self.checker_callback_tag = GLib.io_add_watch(

1097

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

750

self.checker_callback_tag = gobject.io_add_watch(

751

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

1098

752

self.checker_callback, pipe[0], command)

1099

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

753

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

1100

754

return True

1101

755

1102

756

def stop_checker(self):

1103

757

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

1104

758

if self.checker_callback_tag:

1105

GLib.source_remove(self.checker_callback_tag)

759

gobject.source_remove(self.checker_callback_tag)

1106

760

self.checker_callback_tag = None

1107

761

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

1108

762

return

1117

771

byte_arrays=False):

1118

772

"""Decorators for marking methods of a DBusObjectWithProperties to

1119

773

become properties on the D-Bus.

1120

774

1121

775

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

1122

776

and with one argument by "Set".

1123

777

1124

778

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

1125

779

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

1126

780

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

1130

784

if byte_arrays and signature != "ay":

1131

785

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

1132

786

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

1133

787

1134

788

def decorator(func):

1135

789

func._dbus_is_property = True

1136

790

func._dbus_interface = dbus_interface

1139

793

func._dbus_name = func.__name__

1140

794

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

1141

795

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

1142

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

796

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1143

797

return func

1144

798

1145

799

return decorator

1146

800

1147

801

1148

802

def dbus_interface_annotations(dbus_interface):

1149

803

"""Decorator for marking functions returning interface annotations

1150

804

1151

805

Usage:

1152

806

1153

807

@dbus_interface_annotations("org.example.Interface")

1154

808

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

1155

809

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

1156

810

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

1157

811

"false"}

1158

812

"""

1159

813

1160

814

def decorator(func):

1161

815

func._dbus_is_interface = True

1162

816

func._dbus_interface = dbus_interface

1163

817

func._dbus_name = dbus_interface

1164

818

return func

1165

819

1166

820

return decorator

1167

821

1168

822

1169

823

def dbus_annotations(annotations):

1170

824

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

1171

825

Usage:

1172

826

1173

827

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

1174

828

"org.freedesktop.DBus.Property."

1175

829

"EmitsChangedSignal": "false"})

1177

831

access="r")

1178

832

def Property_dbus_property(self):

1179

833

return dbus.Boolean(False)

1180

1181

See also the DBusObjectWithAnnotations class.

1182

834

"""

1183

835

1184

836

def decorator(func):

1185

837

func._dbus_annotations = annotations

1186

838

return func

1187

839

1188

840

return decorator

1189

841

1190

842

1206

858

pass

1207

859

1208

860

1209

class DBusObjectWithAnnotations(dbus.service.Object):

1210

"""A D-Bus object with annotations.

1211

1212

Classes inheriting from this can use the dbus_annotations

1213

decorator to add annotations to methods or signals.

861

class DBusObjectWithProperties(dbus.service.Object):

862

"""A D-Bus object with properties.

863

864

Classes inheriting from this can use the dbus_service_property

865

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

866

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

1214

867

"""

1215

868

1216

869

@staticmethod

1217

870

def _is_dbus_thing(thing):

1218

871

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

1219

872

1220

873

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

1221

874

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

1222

875

"""

1223

876

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

1224

877

False)

1225

878

1226

879

def _get_all_dbus_things(self, thing):

1227

880

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

1228

881

"""

1231

884

for cls in self.__class__.__mro__

1232

885

for name, athing in

1233

886

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

1234

1235

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1236

out_signature="s",

1237

path_keyword='object_path',

1238

connection_keyword='connection')

1239

def Introspect(self, object_path, connection):

1240

"""Overloading of standard D-Bus method.

1241

1242

Inserts annotation tags on methods and signals.

1243

"""

1244

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

1245

connection)

1246

try:

1247

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

1248

1249

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

1250

# Add annotation tags

1251

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

1252

for tag in if_tag.getElementsByTagName(typ):

1253

annots = dict()

1254

for name, prop in (self.

1255

_get_all_dbus_things(typ)):

1256

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

1257

and prop._dbus_interface

1258

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

1259

annots.update(getattr(

1260

prop, "_dbus_annotations", {}))

1261

for name, value in annots.items():

1262

ann_tag = document.createElement(

1263

"annotation")

1264

ann_tag.setAttribute("name", name)

1265

ann_tag.setAttribute("value", value)

1266

tag.appendChild(ann_tag)

1267

# Add interface annotation tags

1268

for annotation, value in dict(

1269

itertools.chain.from_iterable(

1270

annotations().items()

1271

for name, annotations

1272

in self._get_all_dbus_things("interface")

1273

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

1274

)).items():

1275

ann_tag = document.createElement("annotation")

1276

ann_tag.setAttribute("name", annotation)

1277

ann_tag.setAttribute("value", value)

1278

if_tag.appendChild(ann_tag)

1279

# Fix argument name for the Introspect method itself

1280

if (if_tag.getAttribute("name")

1281

== dbus.INTROSPECTABLE_IFACE):

1282

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

1283

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

1284

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

1285

if (arg.getAttribute("direction")

1286

== "out"):

1287

arg.setAttribute("name",

1288

"xml_data")

1289

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

1290

document.unlink()

1291

except (AttributeError, xml.dom.DOMException,

1292

xml.parsers.expat.ExpatError) as error:

1293

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

1294

exc_info=error)

1295

return xmlstring

1296

1297

1298

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1299

"""A D-Bus object with properties.

1300

1301

Classes inheriting from this can use the dbus_service_property

1302

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

1303

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

1304

"""

1305

887

1306

888

def _get_dbus_property(self, interface_name, property_name):

1307

889

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

1308

890

property with the specified name and interface.

1313

895

if (value._dbus_name == property_name

1314

896

and value._dbus_interface == interface_name):

1315

897

return value.__get__(self)

1316

898

1317

899

# No such property

1318

900

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

1319

901

self.dbus_object_path, interface_name, property_name))

1320

1321

@classmethod

1322

def _get_all_interface_names(cls):

1323

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

1324

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

1325

"_dbus_interface", None)

1326

for x in (inspect.getmro(cls))

1327

for attr in dir(x))

1328

if name is not None)

1329

902

1330

903

@dbus.service.method(dbus.PROPERTIES_IFACE,

1331

904

in_signature="ss",

1332

905

out_signature="v")

1340

913

if not hasattr(value, "variant_level"):

1341

914

return value

1342

915

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

1343

916

1344

917

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

1345

918

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

1346

919

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

1358

931

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

1359

932

for byte in value))

1360

933

prop(value)

1361

934

1362

935

@dbus.service.method(dbus.PROPERTIES_IFACE,

1363

936

in_signature="s",

1364

937

out_signature="a{sv}")

1365

938

def GetAll(self, interface_name):

1366

939

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

1367

940

standard.

1368

941

1369

942

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

1370

943

"""

1371

944

properties = {}

1382

955

properties[name] = value

1383

956

continue

1384

957

properties[name] = type(value)(

1385

value, variant_level=value.variant_level + 1)

958

value, variant_level = value.variant_level + 1)

1386

959

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

1387

960

1388

961

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

1389

962

def PropertiesChanged(self, interface_name, changed_properties,

1390

963

invalidated_properties):

1392

965

standard.

1393

966

"""

1394

967

pass

1395

968

1396

969

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1397

970

out_signature="s",

1398

971

path_keyword='object_path',

1399

972

connection_keyword='connection')

1400

973

def Introspect(self, object_path, connection):

1401

974

"""Overloading of standard D-Bus method.

1402

975

1403

976

Inserts property tags and interface annotation tags.

1404

977

"""

1405

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1406

object_path,

1407

connection)

978

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

979

connection)

1408

980

try:

1409

981

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

1410

982

1411

983

def make_tag(document, name, prop):

1412

984

e = document.createElement("property")

1413

985

e.setAttribute("name", name)

1414

986

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

1415

987

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

1416

988

return e

1417

989

1418

990

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

1419

991

# Add property tags

1420

992

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

1423

995

if prop._dbus_interface

1424

996

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

1425

997

if_tag.appendChild(tag)

1426

# Add annotation tags for properties

1427

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

1428

annots = dict()

1429

for name, prop in self._get_all_dbus_things(

1430

"property"):

1431

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

1432

and prop._dbus_interface

1433

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

1434

annots.update(getattr(

1435

prop, "_dbus_annotations", {}))

1436

for name, value in annots.items():

1437

ann_tag = document.createElement(

1438

"annotation")

1439

ann_tag.setAttribute("name", name)

1440

ann_tag.setAttribute("value", value)

1441

tag.appendChild(ann_tag)

998

# Add annotation tags

999

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

1000

for tag in if_tag.getElementsByTagName(typ):

1001

annots = dict()

1002

for name, prop in (self.

1003

_get_all_dbus_things(typ)):

1004

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

1005

and prop._dbus_interface

1006

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

1007

annots.update(getattr(

1008

prop, "_dbus_annotations", {}))

1009

for name, value in annots.items():

1010

ann_tag = document.createElement(

1011

"annotation")

1012

ann_tag.setAttribute("name", name)

1013

ann_tag.setAttribute("value", value)

1014

tag.appendChild(ann_tag)

1015

# Add interface annotation tags

1016

for annotation, value in dict(

1017

itertools.chain.from_iterable(

1018

annotations().items()

1019

for name, annotations

1020

in self._get_all_dbus_things("interface")

1021

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

1022

)).items():

1023

ann_tag = document.createElement("annotation")

1024

ann_tag.setAttribute("name", annotation)

1025

ann_tag.setAttribute("value", value)

1026

if_tag.appendChild(ann_tag)

1442

1027

# Add the names to the return values for the

1443

1028

# "org.freedesktop.DBus.Properties" methods

1444

1029

if (if_tag.getAttribute("name")

1463

1048

return xmlstring

1464

1049

1465

1050

1466

try:

1467

dbus.OBJECT_MANAGER_IFACE

1468

except AttributeError:

1469

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

1470

1471

1472

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1473

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

1474

1475

Classes inheriting from this exposes the standard

1476

GetManagedObjects call and the InterfacesAdded and

1477

InterfacesRemoved signals on the standard

1478

"org.freedesktop.DBus.ObjectManager" interface.

1479

1480

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

1481

manually.

1482

"""

1483

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1484

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

1485

def GetManagedObjects(self):

1486

"""This function must be overridden"""

1487

raise NotImplementedError()

1488

1489

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1490

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

1491

def InterfacesAdded(self, object_path, interfaces_and_properties):

1492

pass

1493

1494

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

1495

def InterfacesRemoved(self, object_path, interfaces):

1496

pass

1497

1498

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1499

out_signature="s",

1500

path_keyword='object_path',

1501

connection_keyword='connection')

1502

def Introspect(self, object_path, connection):

1503

"""Overloading of standard D-Bus method.

1504

1505

Override return argument name of GetManagedObjects to be

1506

"objpath_interfaces_and_properties"

1507

"""

1508

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1509

object_path,

1510

connection)

1511

try:

1512

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

1513

1514

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

1515

# Fix argument name for the GetManagedObjects method

1516

if (if_tag.getAttribute("name")

1517

== dbus.OBJECT_MANAGER_IFACE):

1518

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

1519

if (cn.getAttribute("name")

1520

== "GetManagedObjects"):

1521

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

1522

if (arg.getAttribute("direction")

1523

== "out"):

1524

arg.setAttribute(

1525

"name",

1526

"objpath_interfaces"

1527

"_and_properties")

1528

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

1529

document.unlink()

1530

except (AttributeError, xml.dom.DOMException,

1531

xml.parsers.expat.ExpatError) as error:

1532

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

1533

exc_info=error)

1534

return xmlstring

1535

1536

1537

1051

def datetime_to_dbus(dt, variant_level=0):

1538

1052

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

1539

1053

if dt is None:

1540

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

1054

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

1541

1055

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

1542

1056

1543

1057

1546

1060

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

1547

1061

interface names according to the "alt_interface_names" mapping.

1548

1062

Usage:

1549

1063

1550

1064

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

1551

1065

"net.example.AlternateInterface"})

1552

1066

class SampleDBusObject(dbus.service.Object):

1553

1067

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

1554

1068

def SampleDBusMethod():

1555

1069

pass

1556

1070

1557

1071

The above "SampleDBusMethod" on "SampleDBusObject" will be

1558

1072

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

1559

1073

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

1560

1074

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

1561

1075

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

1562

1076

1563

1077

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

1564

1078

(from DBusObjectWithProperties) and interfaces (from the

1565

1079

dbus_interface_annotations decorator).

1566

1080

"""

1567

1081

1568

1082

def wrapper(cls):

1569

1083

for orig_interface_name, alt_interface_name in (

1570

1084

alt_interface_names.items()):

1585

1099

interface_names.add(alt_interface)

1586

1100

# Is this a D-Bus signal?

1587

1101

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

1588

# Extract the original non-method undecorated

1589

# function by black magic

1590

1102

if sys.version_info.major == 2:

1103

# Extract the original non-method undecorated

1104

# function by black magic

1591

1105

nonmethod_func = (dict(

1592

1106

zip(attribute.func_code.co_freevars,

1593

1107

attribute.__closure__))

1594

1108

["func"].cell_contents)

1595

1109

else:

1596

nonmethod_func = (dict(

1597

zip(attribute.__code__.co_freevars,

1598

attribute.__closure__))

1599

["func"].cell_contents)

1110

nonmethod_func = attribute

1600

1111

# Create a new, but exactly alike, function

1601

1112

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

1602

1113

# with the alternate D-Bus interface name

1603

new_function = copy_function(nonmethod_func)

1114

if sys.version_info.major == 2:

1115

new_function = types.FunctionType(

1116

nonmethod_func.func_code,

1117

nonmethod_func.func_globals,

1118

nonmethod_func.func_name,

1119

nonmethod_func.func_defaults,

1120

nonmethod_func.func_closure)

1121

else:

1122

new_function = types.FunctionType(

1123

nonmethod_func.__code__,

1124

nonmethod_func.__globals__,

1125

nonmethod_func.__name__,

1126

nonmethod_func.__defaults__,

1127

nonmethod_func.__closure__)

1604

1128

new_function = (dbus.service.signal(

1605

1129

alt_interface,

1606

1130

attribute._dbus_signature)(new_function))

1610

1134

attribute._dbus_annotations)

1611

1135

except AttributeError:

1612

1136

pass

1613

1614

1137

# Define a creator of a function to call both the

1615

1138

# original and alternate functions, so both the

1616

1139

# original and alternate signals gets sent when

1619

1142

"""This function is a scope container to pass

1620

1143

func1 and func2 to the "call_both" function

1621

1144

outside of its arguments"""

1622

1623

@functools.wraps(func2)

1145

1624

1146

def call_both(*args, **kwargs):

1625

1147

"""This function will emit two D-Bus

1626

1148

signals by calling func1 and func2"""

1627

1149

func1(*args, **kwargs)

1628

1150

func2(*args, **kwargs)

1629

# Make wrapper function look like a D-Bus

1630

# signal

1631

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

1632

if name.startswith("_dbus_"):

1633

setattr(call_both, name, attr)

1634

1151

1635

1152

return call_both

1636

1153

# Create the "call_both" function and add it to

1637

1154

# the class

1647

1164

alt_interface,

1648

1165

attribute._dbus_in_signature,

1649

1166

attribute._dbus_out_signature)

1650

(copy_function(attribute)))

1167

(types.FunctionType(attribute.func_code,

1168

attribute.func_globals,

1169

attribute.func_name,

1170

attribute.func_defaults,

1171

attribute.func_closure)))

1651

1172

# Copy annotations, if any

1652

1173

try:

1653

1174

attr[attrname]._dbus_annotations = dict(

1665

1186

attribute._dbus_access,

1666

1187

attribute._dbus_get_args_options

1667

1188

["byte_arrays"])

1668

(copy_function(attribute)))

1189

(types.FunctionType(

1190

attribute.func_code,

1191

attribute.func_globals,

1192

attribute.func_name,

1193

attribute.func_defaults,

1194

attribute.func_closure)))

1669

1195

# Copy annotations, if any

1670

1196

try:

1671

1197

attr[attrname]._dbus_annotations = dict(

1680

1206

# to the class.

1681

1207

attr[attrname] = (

1682

1208

dbus_interface_annotations(alt_interface)

1683

(copy_function(attribute)))

1209

(types.FunctionType(attribute.func_code,

1210

attribute.func_globals,

1211

attribute.func_name,

1212

attribute.func_defaults,

1213

attribute.func_closure)))

1684

1214

if deprecate:

1685

1215

# Deprecate all alternate interfaces

1686

iname = "_AlternateDBusNames_interface_annotation{}"

1216

iname="_AlternateDBusNames_interface_annotation{}"

1687

1217

for interface_name in interface_names:

1688

1218

1689

1219

@dbus_interface_annotations(interface_name)

1690

1220

def func(self):

1691

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

1692

"true"}

1221

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

1222

"true" }

1693

1223

# Find an unused name

1694

1224

for aname in (iname.format(i)

1695

1225

for i in itertools.count()):

1699

1229

if interface_names:

1700

1230

# Replace the class with a new subclass of it with

1701

1231

# methods, signals, etc. as created above.

1702

if sys.version_info.major == 2:

1703

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

1704

(cls, ), attr)

1705

else:

1706

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

1707

(cls, ), attr)

1232

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

1233

(cls, ), attr)

1708

1234

return cls

1709

1235

1710

1236

return wrapper

1711

1237

1712

1238

1714

1240

"se.bsnet.fukt.Mandos"})

1715

1241

class ClientDBus(Client, DBusObjectWithProperties):

1716

1242

"""A Client class using D-Bus

1717

1243

1718

1244

Attributes:

1719

1245

dbus_object_path: dbus.ObjectPath

1720

1246

bus: dbus.SystemBus()

1721

1247

"""

1722

1248

1723

1249

runtime_expansions = (Client.runtime_expansions

1724

1250

+ ("dbus_object_path", ))

1725

1251

1726

1252

_interface = "se.recompile.Mandos.Client"

1727

1253

1728

1254

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

1729

1730

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

1255

1256

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

1731

1257

self.bus = bus

1732

1258

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

1733

1259

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

1739

1265

"/clients/" + client_object_name)

1740

1266

DBusObjectWithProperties.__init__(self, self.bus,

1741

1267

self.dbus_object_path)

1742

1268

1743

1269

def notifychangeproperty(transform_func, dbus_name,

1744

1270

type_func=lambda x: x,

1745

1271

variant_level=1,

1747

1273

_interface=_interface):

1748

1274

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

1749

1275

its changes to DBus.

1750

1276

1751

1277

transform_fun: Function that takes a value and a variant_level

1752

1278

and transforms it to a D-Bus type.

1753

1279

dbus_name: D-Bus name of the variable

1756

1282

variant_level: D-Bus variant level. Default: 1

1757

1283

"""

1758

1284

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

1759

1285

1760

1286

def setter(self, value):

1761

1287

if hasattr(self, "dbus_object_path"):

1762

1288

if (not hasattr(self, attrname) or

1769

1295

else:

1770

1296

dbus_value = transform_func(

1771

1297

type_func(value),

1772

variant_level=variant_level)

1298

variant_level = variant_level)

1773

1299

self.PropertyChanged(dbus.String(dbus_name),

1774

1300

dbus_value)

1775

1301

self.PropertiesChanged(

1776

1302

_interface,

1777

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

1778

dbus_value}),

1303

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

1304

dbus_value }),

1779

1305

dbus.Array())

1780

1306

setattr(self, attrname, value)

1781

1307

1782

1308

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

1783

1309

1784

1310

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1785

1311

approvals_pending = notifychangeproperty(dbus.Boolean,

1786

1312

"ApprovalPending",

1787

type_func=bool)

1313

type_func = bool)

1788

1314

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

1789

1315

last_enabled = notifychangeproperty(datetime_to_dbus,

1790

1316

"LastEnabled")

1791

1317

checker = notifychangeproperty(

1792

1318

dbus.Boolean, "CheckerRunning",

1793

type_func=lambda checker: checker is not None)

1319

type_func = lambda checker: checker is not None)

1794

1320

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1795

1321

"LastCheckedOK")

1796

1322

last_checker_status = notifychangeproperty(dbus.Int16,

1801

1327

"ApprovedByDefault")

1802

1328

approval_delay = notifychangeproperty(

1803

1329

dbus.UInt64, "ApprovalDelay",

1804

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

1330

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

1805

1331

approval_duration = notifychangeproperty(

1806

1332

dbus.UInt64, "ApprovalDuration",

1807

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

1333

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

1808

1334

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

1809

1335

timeout = notifychangeproperty(

1810

1336

dbus.UInt64, "Timeout",

1811

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

1337

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

1812

1338

extended_timeout = notifychangeproperty(

1813

1339

dbus.UInt64, "ExtendedTimeout",

1814

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

1340

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

1815

1341

interval = notifychangeproperty(

1816

1342

dbus.UInt64, "Interval",

1817

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

1343

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

1818

1344

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

1819

1345

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

1820

1346

invalidate_only=True)

1821

1347

1822

1348

del notifychangeproperty

1823

1349

1824

1350

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

1825

1351

try:

1826

1352

self.remove_from_connection()

1829

1355

if hasattr(DBusObjectWithProperties, "__del__"):

1830

1356

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

1831

1357

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

1832

1358

1833

1359

def checker_callback(self, source, condition,

1834

1360

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

1835

1361

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

1839

1365

if exitstatus >= 0:

1840

1366

# Emit D-Bus signal

1841

1367

self.CheckerCompleted(dbus.Int16(exitstatus),

1842

# This is specific to GNU libC

1843

dbus.Int64(exitstatus << 8),

1368

dbus.Int64(0),

1844

1369

dbus.String(command))

1845

1370

else:

1846

1371

# Emit D-Bus signal

1847

1372

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

1848

1373

dbus.Int64(

1849

# This is specific to GNU libC

1850

(exitstatus << 8)

1851

| self.last_checker_signal),

1374

self.last_checker_signal),

1852

1375

dbus.String(command))

1853

1376

return ret

1854

1377

1855

1378

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

1856

1379

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

1857

1380

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

1861

1384

# Emit D-Bus signal

1862

1385

self.CheckerStarted(self.current_checker_command)

1863

1386

return r

1864

1387

1865

1388

def _reset_approved(self):

1866

1389

self.approved = None

1867

1390

return False

1868

1391

1869

1392

def approve(self, value=True):

1870

1393

self.approved = value

1871

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

1872

* 1000), self._reset_approved)

1394

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

1395

* 1000), self._reset_approved)

1873

1396

self.send_changedstate()

1874

1875

# D-Bus methods, signals & properties

1876

1877

# Interfaces

1878

1879

# Signals

1880

1397

1398

## D-Bus methods, signals & properties

1399

1400

## Interfaces

1401

1402

## Signals

1403

1881

1404

# CheckerCompleted - signal

1882

1405

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

1883

1406

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

1884

1407

"D-Bus signal"

1885

1408

pass

1886

1409

1887

1410

# CheckerStarted - signal

1888

1411

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

1889

1412

def CheckerStarted(self, command):

1890

1413

"D-Bus signal"

1891

1414

pass

1892

1415

1893

1416

# PropertyChanged - signal

1894

1417

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

1895

1418

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

1896

1419

def PropertyChanged(self, property, value):

1897

1420

"D-Bus signal"

1898

1421

pass

1899

1422

1900

1423

# GotSecret - signal

1901

1424

@dbus.service.signal(_interface)

1902

1425

def GotSecret(self):

1905

1428

server to mandos-client

1906

1429

"""

1907

1430

pass

1908

1431

1909

1432

# Rejected - signal

1910

1433

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

1911

1434

def Rejected(self, reason):

1912

1435

"D-Bus signal"

1913

1436

pass

1914

1437

1915

1438

# NeedApproval - signal

1916

1439

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

1917

1440

def NeedApproval(self, timeout, default):

1918

1441

"D-Bus signal"

1919

1442

return self.need_approval()

1920

1921

# Methods

1922

1443

1444

## Methods

1445

1923

1446

# Approve - method

1924

1447

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

1925

1448

def Approve(self, value):

1926

1449

self.approve(value)

1927

1450

1928

1451

# CheckedOK - method

1929

1452

@dbus.service.method(_interface)

1930

1453

def CheckedOK(self):

1931

1454

self.checked_ok()

1932

1455

1933

1456

# Enable - method

1934

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

1935

1457

@dbus.service.method(_interface)

1936

1458

def Enable(self):

1937

1459

"D-Bus method"

1938

1460

self.enable()

1939

1461

1940

1462

# StartChecker - method

1941

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

1942

1463

@dbus.service.method(_interface)

1943

1464

def StartChecker(self):

1944

1465

"D-Bus method"

1945

1466

self.start_checker()

1946

1467

1947

1468

# Disable - method

1948

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

1949

1469

@dbus.service.method(_interface)

1950

1470

def Disable(self):

1951

1471

"D-Bus method"

1952

1472

self.disable()

1953

1473

1954

1474

# StopChecker - method

1955

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

1956

1475

@dbus.service.method(_interface)

1957

1476

def StopChecker(self):

1958

1477

self.stop_checker()

1959

1960

# Properties

1961

1478

1479

## Properties

1480

1962

1481

# ApprovalPending - property

1963

1482

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

1964

1483

def ApprovalPending_dbus_property(self):

1965

1484

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

1966

1485

1967

1486

# ApprovedByDefault - property

1968

1487

@dbus_service_property(_interface,

1969

1488

signature="b",

1972

1491

if value is None: # get

1973

1492

return dbus.Boolean(self.approved_by_default)

1974

1493

self.approved_by_default = bool(value)

1975

1494

1976

1495

# ApprovalDelay - property

1977

1496

@dbus_service_property(_interface,

1978

1497

signature="t",

1982

1501

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

1983

1502

* 1000)

1984

1503

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

1985

1504

1986

1505

# ApprovalDuration - property

1987

1506

@dbus_service_property(_interface,

1988

1507

signature="t",

1992

1511

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

1993

1512

* 1000)

1994

1513

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

1995

1514

1996

1515

# Name - property

1997

@dbus_annotations(

1998

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

1999

1516

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

2000

1517

def Name_dbus_property(self):

2001

1518

return dbus.String(self.name)

2002

1519

2003

1520

# Fingerprint - property

2004

@dbus_annotations(

2005

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

2006

1521

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

2007

1522

def Fingerprint_dbus_property(self):

2008

1523

return dbus.String(self.fingerprint)

2009

1524

2010

1525

# Host - property

2011

1526

@dbus_service_property(_interface,

2012

1527

signature="s",

2015

1530

if value is None: # get

2016

1531

return dbus.String(self.host)

2017

1532

self.host = str(value)

2018

1533

2019

1534

# Created - property

2020

@dbus_annotations(

2021

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

2022

1535

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

2023

1536

def Created_dbus_property(self):

2024

1537

return datetime_to_dbus(self.created)

2025

1538

2026

1539

# LastEnabled - property

2027

1540

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

2028

1541

def LastEnabled_dbus_property(self):

2029

1542

return datetime_to_dbus(self.last_enabled)

2030

1543

2031

1544

# Enabled - property

2032

1545

@dbus_service_property(_interface,

2033

1546

signature="b",

2039

1552

self.enable()

2040

1553

else:

2041

1554

self.disable()

2042

1555

2043

1556

# LastCheckedOK - property

2044

1557

@dbus_service_property(_interface,

2045

1558

signature="s",

2049

1562

self.checked_ok()

2050

1563

return

2051

1564

return datetime_to_dbus(self.last_checked_ok)

2052

1565

2053

1566

# LastCheckerStatus - property

2054

1567

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

2055

1568

def LastCheckerStatus_dbus_property(self):

2056

1569

return dbus.Int16(self.last_checker_status)

2057

1570

2058

1571

# Expires - property

2059

1572

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

2060

1573

def Expires_dbus_property(self):

2061

1574

return datetime_to_dbus(self.expires)

2062

1575

2063

1576

# LastApprovalRequest - property

2064

1577

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

2065

1578

def LastApprovalRequest_dbus_property(self):

2066

1579

return datetime_to_dbus(self.last_approval_request)

2067

1580

2068

1581

# Timeout - property

2069

1582

@dbus_service_property(_interface,

2070

1583

signature="t",

2085

1598

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

2086

1599

is None):

2087

1600

return

2088

GLib.source_remove(self.disable_initiator_tag)

2089

self.disable_initiator_tag = GLib.timeout_add(

1601

gobject.source_remove(self.disable_initiator_tag)

1602

self.disable_initiator_tag = gobject.timeout_add(

2090

1603

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

2091

1604

self.disable)

2092

1605

2093

1606

# ExtendedTimeout - property

2094

1607

@dbus_service_property(_interface,

2095

1608

signature="t",

2099

1612

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

2100

1613

* 1000)

2101

1614

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

2102

1615

2103

1616

# Interval - property

2104

1617

@dbus_service_property(_interface,

2105

1618

signature="t",

2112

1625

return

2113

1626

if self.enabled:

2114

1627

# Reschedule checker run

2115

GLib.source_remove(self.checker_initiator_tag)

2116

self.checker_initiator_tag = GLib.timeout_add(

1628

gobject.source_remove(self.checker_initiator_tag)

1629

self.checker_initiator_tag = gobject.timeout_add(

2117

1630

value, self.start_checker)

2118

self.start_checker() # Start one now, too

2119

1631

self.start_checker() # Start one now, too

1632

2120

1633

# Checker - property

2121

1634

@dbus_service_property(_interface,

2122

1635

signature="s",

2125

1638

if value is None: # get

2126

1639

return dbus.String(self.checker_command)

2127

1640

self.checker_command = str(value)

2128

1641

2129

1642

# CheckerRunning - property

2130

1643

@dbus_service_property(_interface,

2131

1644

signature="b",

2137

1650

self.start_checker()

2138

1651

else:

2139

1652

self.stop_checker()

2140

1653

2141

1654

# ObjectPath - property

2142

@dbus_annotations(

2143

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

2144

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

2145

1655

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

2146

1656

def ObjectPath_dbus_property(self):

2147

return self.dbus_object_path # is already a dbus.ObjectPath

2148

1657

return self.dbus_object_path # is already a dbus.ObjectPath

1658

2149

1659

# Secret = property

2150

@dbus_annotations(

2151

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

2152

"invalidates"})

2153

1660

@dbus_service_property(_interface,

2154

1661

signature="ay",

2155

1662

access="write",

2156

1663

byte_arrays=True)

2157

1664

def Secret_dbus_property(self, value):

2158

1665

self.secret = bytes(value)

2159

1666

2160

1667

del _interface

2161

1668

2162

1669

2166

1673

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

2167

1674

if not self._pipe.recv():

2168

1675

raise KeyError(fpr)

2169

1676

2170

1677

def __getattribute__(self, name):

2171

1678

if name == '_pipe':

2172

1679

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

2175

1682

if data[0] == 'data':

2176

1683

return data[1]

2177

1684

if data[0] == 'function':

2178

1685

2179

1686

def func(*args, **kwargs):

2180

1687

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

2181

1688

return self._pipe.recv()[1]

2182

1689

2183

1690

return func

2184

1691

2185

1692

def __setattr__(self, name, value):

2186

1693

if name == '_pipe':

2187

1694

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

2190

1697

2191

1698

class ClientHandler(socketserver.BaseRequestHandler, object):

2192

1699

"""A class to handle client connections.

2193

1700

2194

1701

Instantiated once for each connection to handle it.

2195

1702

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

2196

1703

2197

1704

def handle(self):

2198

1705

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

2199

1706

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

2200

1707

str(self.client_address))

2201

1708

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

2202

1709

self.server.child_pipe.fileno())

2203

2204

session = gnutls.ClientSession(self.request)

2205

2206

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

2207

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

2208

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

2209

# "+DHE-DSS"))

1710

1711

session = gnutls.connection.ClientSession(

1712

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

1713

1714

# Note: gnutls.connection.X509Credentials is really a

1715

# generic GnuTLS certificate credentials object so long as

1716

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

1717

# here despite using OpenPGP certificates.

1718

1719

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

1720

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

1721

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

1722

# "+DHE-DSS"))

2210

1723

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

2211

1724

priority = self.server.gnutls_priority

2212

1725

if priority is None:

2213

1726

priority = "NORMAL"

2214

gnutls.priority_set_direct(session._c_object,

2215

priority.encode("utf-8"),

2216

None)

2217

1727

gnutls.library.functions.gnutls_priority_set_direct(

1728

session._c_object, priority, None)

1729

2218

1730

# Start communication using the Mandos protocol

2219

1731

# Get protocol number

2220

1732

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

2225

1737

except (ValueError, IndexError, RuntimeError) as error:

2226

1738

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

2227

1739

return

2228

1740

2229

1741

# Start GnuTLS connection

2230

1742

try:

2231

1743

session.handshake()

2232

except gnutls.Error as error:

1744

except gnutls.errors.GNUTLSError as error:

2233

1745

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

2234

1746

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

2235

1747

# established. Just abandon the request.

2236

1748

return

2237

1749

logger.debug("Handshake succeeded")

2238

1750

2239

1751

approval_required = False

2240

1752

try:

2241

1753

try:

2242

1754

fpr = self.fingerprint(

2243

1755

self.peer_certificate(session))

2244

except (TypeError, gnutls.Error) as error:

1756

except (TypeError,

1757

gnutls.errors.GNUTLSError) as error:

2245

1758

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

2246

1759

return

2247

1760

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

2248

1761

2249

1762

try:

2250

1763

client = ProxyClient(child_pipe, fpr,

2251

1764

self.client_address)

2252

1765

except KeyError:

2253

1766

return

2254

1767

2255

1768

if client.approval_delay:

2256

1769

delay = client.approval_delay

2257

1770

client.approvals_pending += 1

2258

1771

approval_required = True

2259

1772

2260

1773

while True:

2261

1774

if not client.enabled:

2262

1775

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

2265

1778

# Emit D-Bus signal

2266

1779

client.Rejected("Disabled")

2267

1780

return

2268

1781

2269

1782

if client.approved or not client.approval_delay:

2270

# We are approved or approval is disabled

1783

#We are approved or approval is disabled

2271

1784

break

2272

1785

elif client.approved is None:

2273

1786

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

2284

1797

# Emit D-Bus signal

2285

1798

client.Rejected("Denied")

2286

1799

return

2287

2288

# wait until timeout or approved

1800

1801

#wait until timeout or approved

2289

1802

time = datetime.datetime.now()

2290

1803

client.changedstate.acquire()

2291

1804

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

2304

1817

break

2305

1818

else:

2306

1819

delay -= time2 - time

2307

2308

try:

2309

session.send(client.secret)

2310

except gnutls.Error as error:

2311

logger.warning("gnutls send failed",

2312

exc_info=error)

2313

return

2314

1820

1821

sent_size = 0

1822

while sent_size < len(client.secret):

1823

try:

1824

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

1825

except gnutls.errors.GNUTLSError as error:

1826

logger.warning("gnutls send failed",

1827

exc_info=error)

1828

return

1829

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

1830

len(client.secret) - (sent_size

1831

+ sent))

1832

sent_size += sent

1833

2315

1834

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

2316

1835

# bump the timeout using extended_timeout

2317

1836

client.bump_timeout(client.extended_timeout)

2318

1837

if self.server.use_dbus:

2319

1838

# Emit D-Bus signal

2320

1839

client.GotSecret()

2321

1840

2322

1841

finally:

2323

1842

if approval_required:

2324

1843

client.approvals_pending -= 1

2325

1844

try:

2326

1845

session.bye()

2327

except gnutls.Error as error:

1846

except gnutls.errors.GNUTLSError as error:

2328

1847

logger.warning("GnuTLS bye failed",

2329

1848

exc_info=error)

2330

1849

2331

1850

@staticmethod

2332

1851

def peer_certificate(session):

2333

1852

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

2334

1853

# If not an OpenPGP certificate...

2335

if (gnutls.certificate_type_get(session._c_object)

2336

!= gnutls.CRT_OPENPGP):

2337

# ...return invalid data

2338

return b""

1854

if (gnutls.library.functions.gnutls_certificate_type_get(

1855

session._c_object)

1856

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1857

# ...do the normal thing

1858

return session.peer_certificate

2339

1859

list_size = ctypes.c_uint(1)

2340

cert_list = (gnutls.certificate_get_peers

1860

cert_list = (gnutls.library.functions

1861

.gnutls_certificate_get_peers

2341

1862

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

2342

1863

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

2343

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

1864

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

1865

" certificate")

2344

1866

if list_size.value == 0:

2345

1867

return None

2346

1868

cert = cert_list[0]

2347

1869

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

2348

1870

2349

1871

@staticmethod

2350

1872

def fingerprint(openpgp):

2351

1873

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2352

1874

# New GnuTLS "datum" with the OpenPGP public key

2353

datum = gnutls.datum_t(

1875

datum = gnutls.library.types.gnutls_datum_t(

2354

1876

ctypes.cast(ctypes.c_char_p(openpgp),

2355

1877

ctypes.POINTER(ctypes.c_ubyte)),

2356

1878

ctypes.c_uint(len(openpgp)))

2357

1879

# New empty GnuTLS certificate

2358

crt = gnutls.openpgp_crt_t()

2359

gnutls.openpgp_crt_init(ctypes.byref(crt))

1880

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1881

gnutls.library.functions.gnutls_openpgp_crt_init(

1882

ctypes.byref(crt))

2360

1883

# Import the OpenPGP public key into the certificate

2361

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

2362

gnutls.OPENPGP_FMT_RAW)

1884

gnutls.library.functions.gnutls_openpgp_crt_import(

1885

crt, ctypes.byref(datum),

1886

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

2363

1887

# Verify the self signature in the key

2364

1888

crtverify = ctypes.c_uint()

2365

gnutls.openpgp_crt_verify_self(crt, 0,

2366

ctypes.byref(crtverify))

1889

gnutls.library.functions.gnutls_openpgp_crt_verify_self(

1890

crt, 0, ctypes.byref(crtverify))

2367

1891

if crtverify.value != 0:

2368

gnutls.openpgp_crt_deinit(crt)

2369

raise gnutls.CertificateSecurityError("Verify failed")

1892

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1893

raise gnutls.errors.CertificateSecurityError(

1894

"Verify failed")

2370

1895

# New buffer for the fingerprint

2371

1896

buf = ctypes.create_string_buffer(20)

2372

1897

buf_len = ctypes.c_size_t()

2373

1898

# Get the fingerprint from the certificate into the buffer

2374

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

2375

ctypes.byref(buf_len))

1899

gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(

1900

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

2376

1901

# Deinit the certificate

2377

gnutls.openpgp_crt_deinit(crt)

1902

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2378

1903

# Convert the buffer to a Python bytestring

2379

1904

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

2380

1905

# Convert the bytestring to hexadecimal notation

2384

1909

2385

1910

class MultiprocessingMixIn(object):

2386

1911

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

2387

1912

2388

1913

def sub_process_main(self, request, address):

2389

1914

try:

2390

1915

self.finish_request(request, address)

2391

1916

except Exception:

2392

1917

self.handle_error(request, address)

2393

1918

self.close_request(request)

2394

1919

2395

1920

def process_request(self, request, address):

2396

1921

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

2397

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

2398

args=(request, address))

1922

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

1923

args = (request, address))

2399

1924

proc.start()

2400

1925

return proc

2401

1926

2402

1927

2403

1928

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2404

1929

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

2405

1930

2406

1931

def process_request(self, request, client_address):

2407

1932

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

2408

1933

2409

1934

This function creates a new pipe in self.pipe

2410

1935

"""

2411

1936

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2412

1937

2413

1938

proc = MultiprocessingMixIn.process_request(self, request,

2414

1939

client_address)

2415

1940

self.child_pipe.close()

2416

1941

self.add_pipe(parent_pipe, proc)

2417

1942

2418

1943

def add_pipe(self, parent_pipe, proc):

2419

1944

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

2420

1945

raise NotImplementedError()

2423

1948

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2424

1949

socketserver.TCPServer, object):

2425

1950

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

2426

1951

2427

1952

Attributes:

2428

1953

enabled: Boolean; whether this server is activated yet

2429

1954

interface: None or a network interface name (string)

2430

1955

use_ipv6: Boolean; to use IPv6 or not

2431

1956

"""

2432

1957

2433

1958

def __init__(self, server_address, RequestHandlerClass,

2434

1959

interface=None,

2435

1960

use_ipv6=True,

2445

1970

self.socketfd = socketfd

2446

1971

# Save the original socket.socket() function

2447

1972

self.socket_socket = socket.socket

2448

2449

1973

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

2450

#

1974

#

2451

1975

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

2452

1976

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

2453

1977

# patching socket.socket.)

2454

#

1978

#

2455

1979

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

2456

1980

@functools.wraps(socket.socket)

2457

1981

def socket_wrapper(*args, **kwargs):

2469

1993

# socket_wrapper(), if socketfd was set.

2470

1994

socketserver.TCPServer.__init__(self, server_address,

2471

1995

RequestHandlerClass)

2472

1996

2473

1997

def server_bind(self):

2474

1998

"""This overrides the normal server_bind() function

2475

1999

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

2476

2000

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

2477

global SO_BINDTODEVICE

2478

2001

if self.interface is not None:

2479

2002

if SO_BINDTODEVICE is None:

2480

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

2481

# common enough.

2482

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

2483

SO_BINDTODEVICE = 25

2484

try:

2485

self.socket.setsockopt(

2486

socket.SOL_SOCKET, SO_BINDTODEVICE,

2487

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

2488

except socket.error as error:

2489

if error.errno == errno.EPERM:

2490

logger.error("No permission to bind to"

2491

" interface %s", self.interface)

2492

elif error.errno == errno.ENOPROTOOPT:

2493

logger.error("SO_BINDTODEVICE not available;"

2494

" cannot bind to interface %s",

2495

self.interface)

2496

elif error.errno == errno.ENODEV:

2497

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

2498

" cannot bind", self.interface)

2499

else:

2500

raise

2003

logger.error("SO_BINDTODEVICE does not exist;"

2004

" cannot bind to interface %s",

2005

self.interface)

2006

else:

2007

try:

2008

self.socket.setsockopt(

2009

socket.SOL_SOCKET, SO_BINDTODEVICE,

2010

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

2011

except socket.error as error:

2012

if error.errno == errno.EPERM:

2013

logger.error("No permission to bind to"

2014

" interface %s", self.interface)

2015

elif error.errno == errno.ENOPROTOOPT:

2016

logger.error("SO_BINDTODEVICE not available;"

2017

" cannot bind to interface %s",

2018

self.interface)

2019

elif error.errno == errno.ENODEV:

2020

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

2021

" cannot bind", self.interface)

2022

else:

2023

raise

2501

2024

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

2502

2025

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

2503

2026

if not self.server_address[0]:

2504

2027

if self.address_family == socket.AF_INET6:

2505

any_address = "::" # in6addr_any

2028

any_address = "::" # in6addr_any

2506

2029

else:

2507

any_address = "0.0.0.0" # INADDR_ANY

2030

any_address = "0.0.0.0" # INADDR_ANY

2508

2031

self.server_address = (any_address,

2509

2032

self.server_address[1])

2510

2033

elif not self.server_address[1]:

2520

2043

2521

2044

class MandosServer(IPv6_TCPServer):

2522

2045

"""Mandos server.

2523

2046

2524

2047

Attributes:

2525

2048

clients: set of Client objects

2526

2049

gnutls_priority GnuTLS priority string

2527

2050

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

2528

2529

Assumes a GLib.MainLoop event loop.

2051

2052

Assumes a gobject.MainLoop event loop.

2530

2053

"""

2531

2054

2532

2055

def __init__(self, server_address, RequestHandlerClass,

2533

2056

interface=None,

2534

2057

use_ipv6=True,

2544

2067

self.gnutls_priority = gnutls_priority

2545

2068

IPv6_TCPServer.__init__(self, server_address,

2546

2069

RequestHandlerClass,

2547

interface=interface,

2548

use_ipv6=use_ipv6,

2549

socketfd=socketfd)

2550

2070

interface = interface,

2071

use_ipv6 = use_ipv6,

2072

socketfd = socketfd)

2073

2551

2074

def server_activate(self):

2552

2075

if self.enabled:

2553

2076

return socketserver.TCPServer.server_activate(self)

2554

2077

2555

2078

def enable(self):

2556

2079

self.enabled = True

2557

2080

2558

2081

def add_pipe(self, parent_pipe, proc):

2559

2082

# Call "handle_ipc" for both data and EOF events

2560

GLib.io_add_watch(

2083

gobject.io_add_watch(

2561

2084

parent_pipe.fileno(),

2562

GLib.IO_IN | GLib.IO_HUP,

2085

gobject.IO_IN | gobject.IO_HUP,

2563

2086

functools.partial(self.handle_ipc,

2564

parent_pipe=parent_pipe,

2565

proc=proc))

2566

2087

parent_pipe = parent_pipe,

2088

proc = proc))

2089

2567

2090

def handle_ipc(self, source, condition,

2568

2091

parent_pipe=None,

2569

proc=None,

2092

proc = None,

2570

2093

client_object=None):

2571

2094

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

2572

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

2095

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

2573

2096

# Wait for other process to exit

2574

2097

proc.join()

2575

2098

return False

2576

2099

2577

2100

# Read a request from the child

2578

2101

request = parent_pipe.recv()

2579

2102

command = request[0]

2580

2103

2581

2104

if command == 'init':

2582

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

2105

fpr = request[1]

2583

2106

address = request[2]

2584

2585

for c in self.clients.values():

2107

2108

for c in self.clients.itervalues():

2586

2109

if c.fingerprint == fpr:

2587

2110

client = c

2588

2111

break

2595

2118

address[0])

2596

2119

parent_pipe.send(False)

2597

2120

return False

2598

2599

GLib.io_add_watch(

2121

2122

gobject.io_add_watch(

2600

2123

parent_pipe.fileno(),

2601

GLib.IO_IN | GLib.IO_HUP,

2124

gobject.IO_IN | gobject.IO_HUP,

2602

2125

functools.partial(self.handle_ipc,

2603

parent_pipe=parent_pipe,

2604

proc=proc,

2605

client_object=client))

2126

parent_pipe = parent_pipe,

2127

proc = proc,

2128

client_object = client))

2606

2129

parent_pipe.send(True)

2607

2130

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

2608

2131

# same fileno

2611

2134

funcname = request[1]

2612

2135

args = request[2]

2613

2136

kwargs = request[3]

2614

2137

2615

2138

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

2616

2139

funcname)(*args,

2617

2140

**kwargs)))

2618

2141

2619

2142

if command == 'getattr':

2620

2143

attrname = request[1]

2621

2144

if isinstance(client_object.__getattribute__(attrname),

2624

2147

else:

2625

2148

parent_pipe.send((

2626

2149

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

2627

2150

2628

2151

if command == 'setattr':

2629

2152

attrname = request[1]

2630

2153

value = request[2]

2631

2154

setattr(client_object, attrname, value)

2632

2155

2633

2156

return True

2634

2157

2635

2158

2636

2159

def rfc3339_duration_to_delta(duration):

2637

2160

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

2638

2161

2639

2162

>>> rfc3339_duration_to_delta("P7D")

2640

2163

datetime.timedelta(7)

2641

2164

>>> rfc3339_duration_to_delta("PT60S")

2651

2174

>>> rfc3339_duration_to_delta("P1DT3M20S")

2652

2175

datetime.timedelta(1, 200)

2653

2176

"""

2654

2177

2655

2178

# Parsing an RFC 3339 duration with regular expressions is not

2656

2179

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

2657

2180

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

2658

2181

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

2659

2182

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

2660

2183

# avoid excessive use of external libraries.

2661

2184

2662

2185

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

2663

2186

Token = collections.namedtuple("Token", (

2664

2187

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

2697

2220

frozenset((token_year, token_month,

2698

2221

token_day, token_time,

2699

2222

token_week)))

2700

# Define starting values:

2701

# Value so far

2702

value = datetime.timedelta()

2223

# Define starting values

2224

value = datetime.timedelta() # Value so far

2703

2225

found_token = None

2704

# Following valid tokens

2705

followers = frozenset((token_duration, ))

2706

# String left to parse

2707

s = duration

2226

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

2227

s = duration # String left to parse

2708

2228

# Loop until end token is found

2709

2229

while found_token is not token_end:

2710

2230

# Search for any currently valid tokens

2734

2254

2735

2255

def string_to_delta(interval):

2736

2256

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

2737

2257

2738

2258

>>> string_to_delta('7d')

2739

2259

datetime.timedelta(7)

2740

2260

>>> string_to_delta('60s')

2748

2268

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

2749

2269

datetime.timedelta(0, 330)

2750

2270

"""

2751

2271

2752

2272

try:

2753

2273

return rfc3339_duration_to_delta(interval)

2754

2274

except ValueError:

2755

2275

pass

2756

2276

2757

2277

timevalue = datetime.timedelta(0)

2758

2278

for s in interval.split():

2759

2279

try:

2777

2297

return timevalue

2778

2298

2779

2299

2780

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

2300

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

2781

2301

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

2782

2302

2783

2303

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

2784

2304

if os.fork():

2785

2305

sys.exit()

2803

2323

2804

2324

2805

2325

def main():

2806

2326

2807

2327

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

2808

2328

# Parsing of options, both command line and config file

2809

2329

2810

2330

parser = argparse.ArgumentParser()

2811

2331

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

2812

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

2332

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

2813

2333

help="show version number and exit")

2814

2334

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

2815

2335

help="Bind to interface IF")

2851

2371

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

2852

2372

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

2853

2373

default=None)

2854

2374

2855

2375

options = parser.parse_args()

2856

2376

2857

2377

if options.check:

2858

2378

import doctest

2859

2379

fail_count, test_count = doctest.testmod()

2860

2380

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

2861

2381

2862

2382

# Default values for config file for server-global settings

2863

server_defaults = {"interface": "",

2864

"address": "",

2865

"port": "",

2866

"debug": "False",

2867

"priority":

2868

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

2869

":+SIGN-DSA-SHA256",

2870

"servicename": "Mandos",

2871

"use_dbus": "True",

2872

"use_ipv6": "True",

2873

"debuglevel": "",

2874

"restore": "True",

2875

"socket": "",

2876

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

2877

"foreground": "False",

2878

"zeroconf": "True",

2879

}

2880

2383

server_defaults = { "interface": "",

2384

"address": "",

2385

"port": "",

2386

"debug": "False",

2387

"priority":

2388

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

2389

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

2390

"servicename": "Mandos",

2391

"use_dbus": "True",

2392

"use_ipv6": "True",

2393

"debuglevel": "",

2394

"restore": "True",

2395

"socket": "",

2396

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

2397

"foreground": "False",

2398

"zeroconf": "True",

2399

}

2400

2881

2401

# Parse config file for server-global settings

2882

2402

server_config = configparser.SafeConfigParser(server_defaults)

2883

2403

del server_defaults

2885

2405

# Convert the SafeConfigParser object to a dict

2886

2406

server_settings = server_config.defaults()

2887

2407

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

2888

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

2889

"foreground", "zeroconf"):

2408

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

2890

2409

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

2891

2410

option)

2892

2411

if server_settings["port"]:

2902

2421

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

2903

2422

["socket"])

2904

2423

del server_config

2905

2424

2906

2425

# Override the settings from the config file with command line

2907

2426

# options, if set.

2908

2427

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

2926

2445

if server_settings["debug"]:

2927

2446

server_settings["foreground"] = True

2928

2447

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

2929

2448

2930

2449

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

2931

2450

2932

2451

if (not server_settings["zeroconf"]

2933

2452

and not (server_settings["port"]

2934

2453

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

2935

2454

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

2936

2455

2937

2456

# For convenience

2938

2457

debug = server_settings["debug"]

2939

2458

debuglevel = server_settings["debuglevel"]

2943

2462

stored_state_file)

2944

2463

foreground = server_settings["foreground"]

2945

2464

zeroconf = server_settings["zeroconf"]

2946

2465

2947

2466

if debug:

2948

2467

initlogger(debug, logging.DEBUG)

2949

2468

else:

2952

2471

else:

2953

2472

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

2954

2473

initlogger(debug, level)

2955

2474

2956

2475

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

2957

2476

syslogger.setFormatter(

2958

2477

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

2959

2478

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

2960

2479

server_settings["servicename"])))

2961

2480

2962

2481

# Parse config file with clients

2963

2482

client_config = configparser.SafeConfigParser(Client

2964

2483

.client_defaults)

2965

2484

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

2966

2485

"clients.conf"))

2967

2486

2968

2487

global mandos_dbus_service

2969

2488

mandos_dbus_service = None

2970

2489

2971

2490

socketfd = None

2972

2491

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

2973

2492

socketfd = server_settings["socket"]

2989

2508

except IOError as e:

2990

2509

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

2991

2510

exc_info=e)

2992

2993

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

2994

("mandos", "mandos"),

2995

("nobody", "nogroup")):

2511

2512

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

2996

2513

try:

2997

2514

uid = pwd.getpwnam(name).pw_uid

2998

gid = pwd.getpwnam(group).pw_gid

2515

gid = pwd.getpwnam(name).pw_gid

2999

2516

break

3000

2517

except KeyError:

3001

2518

continue

3005

2522

try:

3006

2523

os.setgid(gid)

3007

2524

os.setuid(uid)

3008

if debug:

3009

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

3010

gid))

3011

2525

except OSError as error:

3012

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

3013

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

3014

2526

if error.errno != errno.EPERM:

3015

2527

raise

3016

2528

3017

2529

if debug:

3018

2530

# Enable all possible GnuTLS debugging

3019

2531

3020

2532

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

3021

2533

# - GnuTLS manual

3022

gnutls.global_set_log_level(11)

3023

3024

@gnutls.log_func

2534

gnutls.library.functions.gnutls_global_set_log_level(11)

2535

2536

@gnutls.library.types.gnutls_log_func

3025

2537

def debug_gnutls(level, string):

3026

2538

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

3027

3028

gnutls.global_set_log_function(debug_gnutls)

3029

2539

2540

gnutls.library.functions.gnutls_global_set_log_function(

2541

debug_gnutls)

2542

3030

2543

# Redirect stdin so all checkers get /dev/null

3031

2544

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

3032

2545

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

3033

2546

if null > 2:

3034

2547

os.close(null)

3035

2548

3036

2549

# Need to fork before connecting to D-Bus

3037

2550

if not foreground:

3038

2551

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

3039

2552

daemon()

3040

3041

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

3042

# to inform GLib that threads will be used.

3043

GLib.threads_init()

3044

2553

2554

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

2555

# need to inform gobject that threads will be used.

2556

gobject.threads_init()

2557

3045

2558

global main_loop

3046

2559

# From the Avahi example code

3047

2560

DBusGMainLoop(set_as_default=True)

3048

main_loop = GLib.MainLoop()

2561

main_loop = gobject.MainLoop()

3049

2562

bus = dbus.SystemBus()

3050

2563

# End of Avahi example code

3051

2564

if use_dbus:

3064

2577

if zeroconf:

3065

2578

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3066

2579

service = AvahiServiceToSyslog(

3067

name=server_settings["servicename"],

3068

servicetype="_mandos._tcp",

3069

protocol=protocol,

3070

bus=bus)

2580

name = server_settings["servicename"],

2581

servicetype = "_mandos._tcp",

2582

protocol = protocol,

2583

bus = bus)

3071

2584

if server_settings["interface"]:

3072

2585

service.interface = if_nametoindex(

3073

2586

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

3074

2587

3075

2588

global multiprocessing_manager

3076

2589

multiprocessing_manager = multiprocessing.Manager()

3077

2590

3078

2591

client_class = Client

3079

2592

if use_dbus:

3080

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

3081

2593

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

2594

3082

2595

client_settings = Client.config_parser(client_config)

3083

2596

old_client_settings = {}

3084

2597

clients_data = {}

3085

2598

3086

2599

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

3087

2600

global wnull

3088

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

2601

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

3089

2602

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

3090

2603

# mode

3091

2604

if debug or not foreground:

3092

2605

wnull.close()

3093

2606

3094

2607

# Get client data and settings from last running state.

3095

2608

if server_settings["restore"]:

3096

2609

try:

3097

2610

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

3098

if sys.version_info.major == 2:

3099

clients_data, old_client_settings = pickle.load(

3100

stored_state)

3101

else:

3102

bytes_clients_data, bytes_old_client_settings = (

3103

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

3104

# Fix bytes to strings

3105

# clients_data

3106

# .keys()

3107

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

3108

if isinstance(key, bytes)

3109

else key): value

3110

for key, value in

3111

bytes_clients_data.items()}

3112

del bytes_clients_data

3113

for key in clients_data:

3114

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

3115

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

3116

for k, v in

3117

clients_data[key].items()}

3118

clients_data[key] = value

3119

# .client_structure

3120

value["client_structure"] = [

3121

(s.decode("utf-8")

3122

if isinstance(s, bytes)

3123

else s) for s in

3124

value["client_structure"]]

3125

# .name & .host

3126

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

3127

if isinstance(value[k], bytes):

3128

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

3129

# old_client_settings

3130

# .keys()

3131

old_client_settings = {

3132

(key.decode("utf-8")

3133

if isinstance(key, bytes)

3134

else key): value

3135

for key, value in

3136

bytes_old_client_settings.items()}

3137

del bytes_old_client_settings

3138

# .host

3139

for value in old_client_settings.values():

3140

if isinstance(value["host"], bytes):

3141

value["host"] = (value["host"]

3142

.decode("utf-8"))

2611

clients_data, old_client_settings = pickle.load(

2612

stored_state)

3143

2613

os.remove(stored_state_path)

3144

2614

except IOError as e:

3145

2615

if e.errno == errno.ENOENT:

3153

2623

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

3154

2624

"EOFError:",

3155

2625

exc_info=e)

3156

2626

3157

2627

with PGPEngine() as pgp:

3158

2628

for client_name, client in clients_data.items():

3159

2629

# Skip removed clients

3160

2630

if client_name not in client_settings:

3161

2631

continue

3162

2632

3163

2633

# Decide which value to use after restoring saved state.

3164

2634

# We have three different values: Old config file,

3165

2635

# new config file, and saved state.

3176

2646

client[name] = value

3177

2647

except KeyError:

3178

2648

pass

3179

2649

3180

2650

# Clients who has passed its expire date can still be

3181

2651

# enabled if its last checker was successful. A Client

3182

2652

# whose checker succeeded before we stored its state is

3215

2685

client_name))

3216

2686

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

3217

2687

["secret"])

3218

2688

3219

2689

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

3220

2690

for client_name in (set(old_client_settings)

3221

2691

- set(client_settings)):

3223

2693

for client_name in (set(client_settings)

3224

2694

- set(old_client_settings)):

3225

2695

clients_data[client_name] = client_settings[client_name]

3226

2696

3227

2697

# Create all client objects

3228

2698

for client_name, client in clients_data.items():

3229

2699

tcp_server.clients[client_name] = client_class(

3230

name=client_name,

3231

settings=client,

3232

server_settings=server_settings)

3233

2700

name = client_name,

2701

settings = client,

2702

server_settings = server_settings)

2703

3234

2704

if not tcp_server.clients:

3235

2705

logger.warning("No clients defined")

3236

2706

3237

2707

if not foreground:

3238

2708

if pidfile is not None:

3239

2709

pid = os.getpid()

3245

2715

pidfilename, pid)

3246

2716

del pidfile

3247

2717

del pidfilename

3248

3249

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

3250

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3251

lambda: main_loop.quit() and False)

3252

2718

2719

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

2720

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

2721

3253

2722

if use_dbus:

3254

2723

3255

2724

@alternate_dbus_interfaces(

3256

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

3257

class MandosDBusService(DBusObjectWithObjectManager):

2725

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

2726

class MandosDBusService(DBusObjectWithProperties):

3258

2727

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

3259

2728

3260

2729

def __init__(self):

3261

2730

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

3262

2731

3263

2732

_interface = "se.recompile.Mandos"

3264

2733

2734

@dbus_interface_annotations(_interface)

2735

def _foo(self):

2736

return {

2737

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

2738

"false" }

2739

3265

2740

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

3266

2741

def ClientAdded(self, objpath):

3267

2742

"D-Bus signal"

3268

2743

pass

3269

2744

3270

2745

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

3271

2746

def ClientNotFound(self, fingerprint, address):

3272

2747

"D-Bus signal"

3273

2748

pass

3274

3275

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

3276

"true"})

2749

3277

2750

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

3278

2751

def ClientRemoved(self, objpath, name):

3279

2752

"D-Bus signal"

3280

2753

pass

3281

3282

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

3283

"true"})

2754

3284

2755

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

3285

2756

def GetAllClients(self):

3286

2757

"D-Bus method"

3287

2758

return dbus.Array(c.dbus_object_path for c in

3288

tcp_server.clients.values())

3289

3290

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

3291

"true"})

2759

tcp_server.clients.itervalues())

2760

3292

2761

@dbus.service.method(_interface,

3293

2762

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

3294

2763

def GetAllClientsWithProperties(self):

3295

2764

"D-Bus method"

3296

2765

return dbus.Dictionary(

3297

{c.dbus_object_path: c.GetAll(

3298

"se.recompile.Mandos.Client")

3299

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

2766

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

2767

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

3300

2768

signature="oa{sv}")

3301

2769

3302

2770

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

3303

2771

def RemoveClient(self, object_path):

3304

2772

"D-Bus method"

3305

for c in tcp_server.clients.values():

2773

for c in tcp_server.clients.itervalues():

3306

2774

if c.dbus_object_path == object_path:

3307

2775

del tcp_server.clients[c.name]

3308

2776

c.remove_from_connection()

3309

# Don't signal the disabling

2777

# Don't signal anything except ClientRemoved

3310

2778

c.disable(quiet=True)

3311

# Emit D-Bus signal for removal

3312

self.client_removed_signal(c)

2779

# Emit D-Bus signal

2780

self.ClientRemoved(object_path, c.name)

3313

2781

return

3314

2782

raise KeyError(object_path)

3315

2783

3316

2784

del _interface

3317

3318

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3319

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

3320

def GetManagedObjects(self):

3321

"""D-Bus method"""

3322

return dbus.Dictionary(

3323

{client.dbus_object_path:

3324

dbus.Dictionary(

3325

{interface: client.GetAll(interface)

3326

for interface in

3327

client._get_all_interface_names()})

3328

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

3329

3330

def client_added_signal(self, client):

3331

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

3332

if use_dbus:

3333

# New standard signal

3334

self.InterfacesAdded(

3335

client.dbus_object_path,

3336

dbus.Dictionary(

3337

{interface: client.GetAll(interface)

3338

for interface in

3339

client._get_all_interface_names()}))

3340

# Old signal

3341

self.ClientAdded(client.dbus_object_path)

3342

3343

def client_removed_signal(self, client):

3344

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

3345

if use_dbus:

3346

# New standard signal

3347

self.InterfacesRemoved(

3348

client.dbus_object_path,

3349

client._get_all_interface_names())

3350

# Old signal

3351

self.ClientRemoved(client.dbus_object_path,

3352

client.name)

3353

2785

3354

2786

mandos_dbus_service = MandosDBusService()

3355

3356

# Save modules to variables to exempt the modules from being

3357

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

3358

mp = multiprocessing

3359

wn = wnull

3360

2787

3361

2788

def cleanup():

3362

2789

"Cleanup function; run on exit"

3363

2790

if zeroconf:

3364

2791

service.cleanup()

3365

3366

mp.active_children()

3367

wn.close()

2792

2793

multiprocessing.active_children()

2794

wnull.close()

3368

2795

if not (tcp_server.clients or client_settings):

3369

2796

return

3370

2797

3371

2798

# Store client before exiting. Secrets are encrypted with key

3372

2799

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

3373

2800

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

3374

2801

clients = {}

3375

2802

with PGPEngine() as pgp:

3376

for client in tcp_server.clients.values():

2803

for client in tcp_server.clients.itervalues():

3377

2804

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

3378

2805

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

3379

2806

key)

3380

2807

client_dict = {}

3381

2808

3382

2809

# A list of attributes that can not be pickled

3383

2810

# + secret.

3384

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

3385

"checker", "server_settings"}

2811

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

2812

"checker", "server_settings" }

3386

2813

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

3387

2814

.Object):

3388

2815

exclude.add(name)

3389

2816

3390

2817

client_dict["encrypted_secret"] = (client

3391

2818

.encrypted_secret)

3392

2819

for attr in client.client_structure:

3393

2820

if attr not in exclude:

3394

2821

client_dict[attr] = getattr(client, attr)

3395

2822

3396

2823

clients[client.name] = client_dict

3397

2824

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

3398

2825

3399

2826

try:

3400

2827

with tempfile.NamedTemporaryFile(

3401

2828

mode='wb',

3403

2830

prefix='clients-',

3404

2831

dir=os.path.dirname(stored_state_path),

3405

2832

delete=False) as stored_state:

3406

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

3407

protocol=2)

2833

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

3408

2834

tempname = stored_state.name

3409

2835

os.rename(tempname, stored_state_path)

3410

2836

except (IOError, OSError) as e:

3420

2846

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

3421

2847

exc_info=e)

3422

2848

raise

3423

2849

3424

2850

# Delete all clients, and settings from config

3425

2851

while tcp_server.clients:

3426

2852

name, client = tcp_server.clients.popitem()

3427

2853

if use_dbus:

3428

2854

client.remove_from_connection()

3429

# Don't signal the disabling

2855

# Don't signal anything except ClientRemoved

3430

2856

client.disable(quiet=True)

3431

# Emit D-Bus signal for removal

3432

2857

if use_dbus:

3433

mandos_dbus_service.client_removed_signal(client)

2858

# Emit D-Bus signal

2859

mandos_dbus_service.ClientRemoved(

2860

client.dbus_object_path, client.name)

3434

2861

client_settings.clear()

3435

2862

3436

2863

atexit.register(cleanup)

3437

3438

for client in tcp_server.clients.values():

2864

2865

for client in tcp_server.clients.itervalues():

3439

2866

if use_dbus:

3440

# Emit D-Bus signal for adding

3441

mandos_dbus_service.client_added_signal(client)

2867

# Emit D-Bus signal

2868

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3442

2869

# Need to initiate checking of clients

3443

2870

if client.enabled:

3444

2871

client.init_checker()

3445

2872

3446

2873

tcp_server.enable()

3447

2874

tcp_server.server_activate()

3448

2875

3449

2876

# Find out what port we got

3450

2877

if zeroconf:

3451

2878

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

3456

2883

else: # IPv4

3457

2884

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

3458

2885

*tcp_server.socket.getsockname())

3459

3460

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

3461

2886

2887

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

2888

3462

2889

try:

3463

2890

if zeroconf:

3464

2891

# From the Avahi example code

3469

2896

cleanup()

3470

2897

sys.exit(1)

3471

2898

# End of Avahi example code

3472

3473

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

3474

lambda *args, **kwargs:

3475

(tcp_server.handle_request

3476

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

3477

2899

2900

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

2901

lambda *args, **kwargs:

2902

(tcp_server.handle_request

2903

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

2904

3478

2905

logger.debug("Starting main loop")

3479

2906

main_loop.run()

3480

2907

except AvahiError as error: