/mandos/trunk : revision 1293

1

#!/usr/bin/python

2

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

1

#!/usr/bin/python3 -bI

2

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

3

#

4

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

5

#

11

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

12

#

13

# Everything else is

14

15

14

15

16

#

17

# This file is part of Mandos.

18

#

31

#

32

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

33

#

34

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

40

39

except ImportError:

41

40

pass

42

41

42

import sys

43

import unittest

44

import argparse

45

import logging

46

import os

43

47

try:

44

48

import SocketServer as socketserver

45

49

except ImportError:

46

50

import socketserver

47

51

import socket

48

import argparse

49

52

import datetime

50

53

import errno

51

54

try:

52

55

import ConfigParser as configparser

53

56

except ImportError:

54

57

import configparser

55

import sys

56

58

import re

57

import os

58

59

import signal

59

60

import subprocess

60

61

import atexit

61

62

import stat

62

import logging

63

import logging.handlers

64

import pwd

65

import contextlib

77

import itertools

78

import collections

79

import codecs

80

import random

81

import shlex

80

82

81

83

import dbus

82

84

import dbus.service

85

import gi

83

86

from gi.repository import GLib

84

87

from dbus.mainloop.glib import DBusGMainLoop

85

88

import ctypes

87

90

import xml.dom.minidom

88

91

import inspect

89

92

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

input = raw_input

97

98

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

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Show warnings by default

114

if not sys.warnoptions:

115

import warnings

116

warnings.simplefilter("default")

117

90

118

# Try to find the value of SO_BINDTODEVICE:

91

119

try:

92

120

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

112

140

# No value found

113

141

SO_BINDTODEVICE = None

114

142

115

if sys.version_info.major == 2:

116

str = unicode

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

117

145

118

version = "1.8.4"

146

version = "1.8.16"

119

147

stored_state_file = "clients.pickle"

120

148

121

logger = logging.getLogger()

149

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

150

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

122

151

syslogger = None

123

152

124

153

try:

160

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

190

address="/dev/log"))

162

191

syslogger.setFormatter(logging.Formatter

163

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

164

' %(message)s'))

165

logger.addHandler(syslogger)

192

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

193

" %(message)s"))

194

log.addHandler(syslogger)

166

195

167

196

if debug:

168

197

console = logging.StreamHandler()

169

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

170

' [%(process)d]:'

171

' %(levelname)s:'

172

' %(message)s'))

173

logger.addHandler(console)

174

logger.setLevel(level)

198

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

199

" [%(process)d]:"

200

" %(levelname)s:"

201

" %(message)s"))

202

log.addHandler(console)

203

log.setLevel(level)

175

204

176

205

177

206

class PGPError(Exception):

179

208

pass

180

209

181

210

182

class PGPEngine(object):

211

class PGPEngine:

183

212

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

184

213

185

214

def __init__(self):

189

218

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

190

219

for line in output.splitlines():

191

220

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

192

if name == "gpg":

221

if name == b"gpg":

193

222

self.gpg = path

194

223

break

195

224

except OSError as e:

196

225

if e.errno != errno.ENOENT:

197

226

raise

198

self.gnupgargs = ['--batch',

199

'--homedir', self.tempdir,

200

'--force-mdc',

201

'--quiet']

227

self.gnupgargs = ["--batch",

228

"--homedir", self.tempdir,

229

"--force-mdc",

230

"--quiet"]

202

231

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

203

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

232

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

204

233

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

205

234

206

235

def __enter__(self):

243

272

dir=self.tempdir) as passfile:

244

273

passfile.write(passphrase)

245

274

passfile.flush()

246

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

247

'--passphrase-file',

275

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

276

"--passphrase-file",

248

277

passfile.name]

249

278

+ self.gnupgargs,

250

279

stdin=subprocess.PIPE,

261

290

dir=self.tempdir) as passfile:

262

291

passfile.write(passphrase)

263

292

passfile.flush()

264

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

265

'--passphrase-file',

293

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

294

"--passphrase-file",

266

295

passfile.name]

267

296

+ self.gnupgargs,

268

297

stdin=subprocess.PIPE,

275

304

276

305

277

306

# Pretend that we have an Avahi module

278

class avahi(object):

307

class avahi:

279

308

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

280

309

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

281

310

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

315

344

pass

316

345

317

346

318

class AvahiService(object):

347

class AvahiService:

319

348

"""An Avahi (Zeroconf) service.

320

349

321

350

Attributes:

322

351

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

323

352

Used to optionally bind to the specified interface.

324

name: string; Example: 'Mandos'

325

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

353

name: string; Example: "Mandos"

354

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

326

355

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

327

356

port: integer; what port to announce

328

357

TXT: list of strings; TXT record for the service

365

394

def rename(self, remove=True):

366

395

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

367

396

if self.rename_count >= self.max_renames:

368

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

369

" after %i retries, exiting.",

370

self.rename_count)

397

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

398

" after %i retries, exiting.",

399

self.rename_count)

371

400

raise AvahiServiceError("Too many renames")

372

401

self.name = str(

373

402

self.server.GetAlternativeServiceName(self.name))

374

403

self.rename_count += 1

375

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

376

self.name)

404

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

405

self.name)

377

406

if remove:

378

407

self.remove()

379

408

try:

381

410

except dbus.exceptions.DBusException as error:

382

411

if (error.get_dbus_name()

383

412

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

384

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

413

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

385

414

return self.rename(remove=False)

386

415

else:

387

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

416

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

388

417

self.cleanup()

389

418

os._exit(1)

390

419

406

435

avahi.DBUS_INTERFACE_ENTRY_GROUP)

407

436

self.entry_group_state_changed_match = (

408

437

self.group.connect_to_signal(

409

'StateChanged', self.entry_group_state_changed))

410

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

411

self.name, self.type)

438

"StateChanged", self.entry_group_state_changed))

439

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

440

self.name, self.type)

412

441

self.group.AddService(

413

442

self.interface,

414

443

self.protocol,

421

450

422

451

def entry_group_state_changed(self, state, error):

423

452

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

424

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

453

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

425

454

426

455

if state == avahi.ENTRY_GROUP_ESTABLISHED:

427

logger.debug("Zeroconf service established.")

456

log.debug("Zeroconf service established.")

428

457

elif state == avahi.ENTRY_GROUP_COLLISION:

429

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

458

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

430

459

self.rename()

431

460

elif state == avahi.ENTRY_GROUP_FAILURE:

432

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

433

str(error))

461

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

462

str(error))

434

463

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

435

464

436

465

def cleanup(self):

446

475

447

476

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

448

477

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

449

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

478

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

450

479

bad_states = {

451

480

avahi.SERVER_INVALID: "Zeroconf server invalid",

452

481

avahi.SERVER_REGISTERING: None,

456

485

if state in bad_states:

457

486

if bad_states[state] is not None:

458

487

if error is None:

459

logger.error(bad_states[state])

488

log.error(bad_states[state])

460

489

else:

461

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

490

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

462

491

self.cleanup()

463

492

elif state == avahi.SERVER_RUNNING:

464

493

try:

466

495

except dbus.exceptions.DBusException as error:

467

496

if (error.get_dbus_name()

468

497

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

469

logger.info("Local Zeroconf service name"

470

" collision.")

498

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

471

499

return self.rename(remove=False)

472

500

else:

473

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

501

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

474

502

self.cleanup()

475

503

os._exit(1)

476

504

else:

477

505

if error is None:

478

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

506

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

479

507

else:

480

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

508

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

481

509

482

510

def activate(self):

483

511

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

495

523

class AvahiServiceToSyslog(AvahiService):

496

524

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

497

525

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

498

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

526

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

527

**kwargs)

499

528

syslogger.setFormatter(logging.Formatter(

500

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

529

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

501

530

.format(self.name)))

502

531

return ret

503

532

504

533

505

534

# Pretend that we have a GnuTLS module

506

class gnutls(object):

535

class gnutls:

507

536

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

508

537

509

538

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

533

562

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

534

563

535

564

# Types

536

class session_int(ctypes.Structure):

565

class _session_int(ctypes.Structure):

537

566

_fields_ = []

538

session_t = ctypes.POINTER(session_int)

567

session_t = ctypes.POINTER(_session_int)

539

568

540

569

class certificate_credentials_st(ctypes.Structure):

541

570

_fields_ = []

544

573

certificate_type_t = ctypes.c_int

545

574

546

575

class datum_t(ctypes.Structure):

547

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

548

('size', ctypes.c_uint)]

576

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

577

("size", ctypes.c_uint)]

549

578

550

class openpgp_crt_int(ctypes.Structure):

579

class _openpgp_crt_int(ctypes.Structure):

551

580

_fields_ = []

552

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

581

openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)

553

582

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

554

583

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

555

584

credentials_type_t = ctypes.c_int

564

593

# gnutls.strerror()

565

594

self.code = code

566

595

if message is None and code is not None:

567

message = gnutls.strerror(code)

596

message = gnutls.strerror(code).decode(

597

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

568

598

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

569

599

message, *args)

570

600

571

601

class CertificateSecurityError(Error):

572

602

pass

573

603

604

class PointerTo:

605

def __init__(self, cls):

606

self.cls = cls

607

608

def from_param(self, obj):

609

if not isinstance(obj, self.cls):

610

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

611

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

612

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

613

614

class CastToVoidPointer:

615

def __init__(self, cls):

616

self.cls = cls

617

618

def from_param(self, obj):

619

if not isinstance(obj, self.cls):

620

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

621

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

622

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

623

624

class With_from_param:

625

@classmethod

626

def from_param(cls, obj):

627

return obj._as_parameter_

628

574

629

# Classes

575

class Credentials(object):

630

class Credentials(With_from_param):

576

631

def __init__(self):

577

self._c_object = gnutls.certificate_credentials_t()

578

gnutls.certificate_allocate_credentials(

579

ctypes.byref(self._c_object))

632

self._as_parameter_ = gnutls.certificate_credentials_t()

633

gnutls.certificate_allocate_credentials(self)

580

634

self.type = gnutls.CRD_CERTIFICATE

581

635

582

636

def __del__(self):

583

gnutls.certificate_free_credentials(self._c_object)

637

gnutls.certificate_free_credentials(self)

584

638

585

class ClientSession(object):

639

class ClientSession(With_from_param):

586

640

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

587

self._c_object = gnutls.session_t()

641

self._as_parameter_ = gnutls.session_t()

588

642

gnutls_flags = gnutls.CLIENT

589

if gnutls.check_version("3.5.6"):

643

if gnutls.check_version(b"3.5.6"):

590

644

gnutls_flags |= gnutls.NO_TICKETS

591

645

if gnutls.has_rawpk:

592

646

gnutls_flags |= gnutls.ENABLE_RAWPK

593

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

647

gnutls.init(self, gnutls_flags)

594

648

del gnutls_flags

595

gnutls.set_default_priority(self._c_object)

596

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

597

gnutls.handshake_set_private_extensions(self._c_object,

598

True)

649

gnutls.set_default_priority(self)

650

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

651

gnutls.handshake_set_private_extensions(self, True)

599

652

self.socket = socket

600

653

if credentials is None:

601

654

credentials = gnutls.Credentials()

602

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

603

ctypes.cast(credentials._c_object,

604

ctypes.c_void_p))

655

gnutls.credentials_set(self, credentials.type,

656

credentials)

605

657

self.credentials = credentials

606

658

607

659

def __del__(self):

608

gnutls.deinit(self._c_object)

660

gnutls.deinit(self)

609

661

610

662

def handshake(self):

611

return gnutls.handshake(self._c_object)

663

return gnutls.handshake(self)

612

664

613

665

def send(self, data):

614

666

data = bytes(data)

615

667

data_len = len(data)

616

668

while data_len > 0:

617

data_len -= gnutls.record_send(self._c_object,

618

data[-data_len:],

669

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

619

670

data_len)

620

671

621

672

def bye(self):

622

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

673

return gnutls.bye(self, gnutls.SHUT_RDWR)

623

674

624

675

# Error handling functions

625

676

def _error_code(result):

626

677

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

627

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

628

if result >= 0:

678

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

679

if result >= gnutls.E_SUCCESS:

629

680

return result

630

681

if result == gnutls.E_NO_CERTIFICATE_FOUND:

631

682

raise gnutls.CertificateSecurityError(code=result)

632

683

raise gnutls.Error(code=result)

633

684

634

def _retry_on_error(result, func, arguments):

685

def _retry_on_error(result, func, arguments,

686

_error_code=_error_code):

635

687

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

636

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

637

while result < 0:

688

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

689

while result < gnutls.E_SUCCESS:

638

690

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

639

691

return _error_code(result)

640

692

result = func(*arguments)

645

697

646

698

# Functions

647

699

priority_set_direct = _library.gnutls_priority_set_direct

648

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

700

priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,

649

701

ctypes.POINTER(ctypes.c_char_p)]

650

702

priority_set_direct.restype = _error_code

651

703

652

704

init = _library.gnutls_init

653

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

705

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

654

706

init.restype = _error_code

655

707

656

708

set_default_priority = _library.gnutls_set_default_priority

657

set_default_priority.argtypes = [session_t]

709

set_default_priority.argtypes = [ClientSession]

658

710

set_default_priority.restype = _error_code

659

711

660

712

record_send = _library.gnutls_record_send

661

record_send.argtypes = [session_t, ctypes.c_void_p,

713

record_send.argtypes = [ClientSession, ctypes.c_void_p,

662

714

ctypes.c_size_t]

663

715

record_send.restype = ctypes.c_ssize_t

664

716

record_send.errcheck = _retry_on_error

666

718

certificate_allocate_credentials = (

667

719

_library.gnutls_certificate_allocate_credentials)

668

720

certificate_allocate_credentials.argtypes = [

669

ctypes.POINTER(certificate_credentials_t)]

721

PointerTo(Credentials)]

670

722

certificate_allocate_credentials.restype = _error_code

671

723

672

724

certificate_free_credentials = (

673

725

_library.gnutls_certificate_free_credentials)

674

certificate_free_credentials.argtypes = [

675

certificate_credentials_t]

726

certificate_free_credentials.argtypes = [Credentials]

676

727

certificate_free_credentials.restype = None

677

728

678

729

handshake_set_private_extensions = (

679

730

_library.gnutls_handshake_set_private_extensions)

680

handshake_set_private_extensions.argtypes = [session_t,

731

handshake_set_private_extensions.argtypes = [ClientSession,

681

732

ctypes.c_int]

682

733

handshake_set_private_extensions.restype = None

683

734

684

735

credentials_set = _library.gnutls_credentials_set

685

credentials_set.argtypes = [session_t, credentials_type_t,

686

ctypes.c_void_p]

736

credentials_set.argtypes = [ClientSession, credentials_type_t,

737

CastToVoidPointer(Credentials)]

687

738

credentials_set.restype = _error_code

688

739

689

740

strerror = _library.gnutls_strerror

691

742

strerror.restype = ctypes.c_char_p

692

743

693

744

certificate_type_get = _library.gnutls_certificate_type_get

694

certificate_type_get.argtypes = [session_t]

745

certificate_type_get.argtypes = [ClientSession]

695

746

certificate_type_get.restype = _error_code

696

747

697

748

certificate_get_peers = _library.gnutls_certificate_get_peers

698

certificate_get_peers.argtypes = [session_t,

749

certificate_get_peers.argtypes = [ClientSession,

699

750

ctypes.POINTER(ctypes.c_uint)]

700

751

certificate_get_peers.restype = ctypes.POINTER(datum_t)

701

752

708

759

global_set_log_function.restype = None

709

760

710

761

deinit = _library.gnutls_deinit

711

deinit.argtypes = [session_t]

762

deinit.argtypes = [ClientSession]

712

763

deinit.restype = None

713

764

714

765

handshake = _library.gnutls_handshake

715

handshake.argtypes = [session_t]

716

handshake.restype = _error_code

766

handshake.argtypes = [ClientSession]

767

handshake.restype = ctypes.c_int

717

768

handshake.errcheck = _retry_on_error

718

769

719

770

transport_set_ptr = _library.gnutls_transport_set_ptr

720

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

771

transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]

721

772

transport_set_ptr.restype = None

722

773

723

774

bye = _library.gnutls_bye

724

bye.argtypes = [session_t, close_request_t]

725

bye.restype = _error_code

775

bye.argtypes = [ClientSession, close_request_t]

776

bye.restype = ctypes.c_int

726

777

bye.errcheck = _retry_on_error

727

778

728

779

check_version = _library.gnutls_check_version

745

796

746

797

x509_crt_fmt_t = ctypes.c_int

747

798

748

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

799

# All the function declarations below are from

800

# gnutls/abstract.h

749

801

pubkey_init = _library.gnutls_pubkey_init

750

802

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

751

803

pubkey_init.restype = _error_code

765

817

pubkey_deinit.argtypes = [pubkey_t]

766

818

pubkey_deinit.restype = None

767

819

else:

768

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

820

# All the function declarations below are from

821

# gnutls/openpgp.h

769

822

770

823

openpgp_crt_init = _library.gnutls_openpgp_crt_init

771

824

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

777

830

openpgp_crt_fmt_t]

778

831

openpgp_crt_import.restype = _error_code

779

832

780

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

781

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

782

ctypes.POINTER(ctypes.c_uint)]

833

openpgp_crt_verify_self = \

834

_library.gnutls_openpgp_crt_verify_self

835

openpgp_crt_verify_self.argtypes = [

836

openpgp_crt_t,

837

ctypes.c_uint,

838

ctypes.POINTER(ctypes.c_uint),

839

]

783

840

openpgp_crt_verify_self.restype = _error_code

784

841

785

842

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

794

851

ctypes.c_size_t)]

795

852

openpgp_crt_get_fingerprint.restype = _error_code

796

853

797

if check_version("3.6.4"):

854

if check_version(b"3.6.4"):

798

855

certificate_type_get2 = _library.gnutls_certificate_type_get2

799

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

856

certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]

800

857

certificate_type_get2.restype = _error_code

801

858

802

859

# Remove non-public functions

814

871

connection.close()

815

872

816

873

817

class Client(object):

874

class Client:

818

875

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

819

876

820

877

Attributes:

821

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

878

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

822

879

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

823

880

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

824

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

825

to see if the client lives.

826

'None' if no process is running.

881

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

882

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

883

running.

827

884

checker_callback_tag: a GLib event source tag, or None

828

885

checker_command: string; External command which is run to check

829

886

if client lives. %() expansions are done at

904

961

# key_id() and fingerprint() functions

905

962

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

906

963

.replace(" ", ""))

907

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

964

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

965

"").upper()

908

966

.replace(" ", ""))

967

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

968

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

969

" fingerprint", client_name)

970

del settings[client_name]

971

continue

909

972

if "secret" in section:

910

973

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

911

974

.encode("utf-8"),

952

1015

self.last_enabled = None

953

1016

self.expires = None

954

1017

955

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

956

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

957

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

1018

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

1019

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

1020

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

958

1021

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

959

1022

datetime.datetime.utcnow())

960

1023

988

1051

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

989

1052

# Already enabled

990

1053

return

991

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

992

1054

self.enabled = True

993

1055

self.last_enabled = datetime.datetime.utcnow()

994

1056

self.init_checker()

999

1061

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

1000

1062

return False

1001

1063

if not quiet:

1002

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

1064

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

1003

1065

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

1004

1066

GLib.source_remove(self.disable_initiator_tag)

1005

1067

self.disable_initiator_tag = None

1017

1079

def __del__(self):

1018

1080

self.disable()

1019

1081

1020

def init_checker(self):

1021

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

1022

# and every interval from then on.

1082

def init_checker(self, randomize_start=False):

1083

# Schedule a new checker to be started a randomly selected

1084

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

1085

# the startup of checkers over time when the server is

1086

# started.

1023

1087

if self.checker_initiator_tag is not None:

1024

1088

GLib.source_remove(self.checker_initiator_tag)

1089

interval_milliseconds = int(self.interval.total_seconds()

1090

* 1000)

1091

if randomize_start:

1092

delay_milliseconds = random.randrange(

1093

interval_milliseconds + 1)

1094

else:

1095

delay_milliseconds = interval_milliseconds

1025

1096

self.checker_initiator_tag = GLib.timeout_add(

1026

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

1027

self.start_checker)

1028

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

1097

delay_milliseconds, self.start_checker, randomize_start)

1098

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

1099

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

1100

# expire at the soonest one interval after a checker was

1101

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

1102

# time might have to be extended.

1103

now = datetime.datetime.utcnow()

1104

self.expires = now + delay + self.interval

1105

# Schedule a disable() at expire time

1029

1106

if self.disable_initiator_tag is not None:

1030

1107

GLib.source_remove(self.disable_initiator_tag)

1031

1108

self.disable_initiator_tag = GLib.timeout_add(

1032

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

1033

# Also start a new checker *right now*.

1034

self.start_checker()

1109

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

1110

self.disable)

1035

1111

1036

1112

def checker_callback(self, source, condition, connection,

1037

1113

command):

1038

1114

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

1039

self.checker_callback_tag = None

1040

self.checker = None

1041

1115

# Read return code from connection (see call_pipe)

1042

1116

returncode = connection.recv()

1043

1117

connection.close()

1118

if self.checker is not None:

1119

self.checker.join()

1120

self.checker_callback_tag = None

1121

self.checker = None

1044

1122

1045

1123

if returncode >= 0:

1046

1124

self.last_checker_status = returncode

1047

1125

self.last_checker_signal = None

1048

1126

if self.last_checker_status == 0:

1049

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

1050

vars(self))

1127

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

1051

1128

self.checked_ok()

1052

1129

else:

1053

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

1130

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

1054

1131

else:

1055

1132

self.last_checker_status = -1

1056

1133

self.last_checker_signal = -returncode

1057

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

1058

vars(self))

1134

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

1059

1135

return False

1060

1136

1061

1137

def checked_ok(self):

1080

1156

def need_approval(self):

1081

1157

self.last_approval_request = datetime.datetime.utcnow()

1082

1158

1083

def start_checker(self):

1159

def start_checker(self, start_was_randomized=False):

1084

1160

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

1085

1161

1086

1162

If a checker already exists, leave it running and do

1095

1171

# should be.

1096

1172

1097

1173

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

1098

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

1174

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

1099

1175

self.checker.join()

1100

1176

self.checker = None

1101

1177

# Start a new checker if needed

1102

1178

if self.checker is None:

1103

1179

# Escape attributes for the shell

1104

1180

escaped_attrs = {

1105

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

1181

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

1106

1182

for attr in self.runtime_expansions}

1107

1183

try:

1108

1184

command = self.checker_command % escaped_attrs

1109

1185

except TypeError as error:

1110

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

1111

self.checker_command,

1112

exc_info=error)

1186

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

1187

self.checker_command, exc_info=error)

1113

1188

return True # Try again later

1114

1189

self.current_checker_command = command

1115

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

1116

self.name)

1190

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

1117

1191

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

1118

1192

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

1119

1193

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

1135

1209

kwargs=popen_args)

1136

1210

self.checker.start()

1137

1211

self.checker_callback_tag = GLib.io_add_watch(

1138

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

1212

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

1213

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1139

1214

self.checker_callback, pipe[0], command)

1215

if start_was_randomized:

1216

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

1217

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

1218

# interval from then on.

1219

now = datetime.datetime.utcnow()

1220

self.checker_initiator_tag = GLib.timeout_add(

1221

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

1222

self.start_checker)

1223

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

1224

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

1225

return False

1140

1226

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

1141

1227

return True

1142

1228

1147

1233

self.checker_callback_tag = None

1148

1234

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

1149

1235

return

1150

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

1236

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

1151

1237

self.checker.terminate()

1152

1238

self.checker = None

1153

1239

1180

1266

func._dbus_name = func.__name__

1181

1267

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

1182

1268

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

1183

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

1269

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

1184

1270

return func

1185

1271

1186

1272

return decorator

1275

1361

1276

1362

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1277

1363

out_signature="s",

1278

path_keyword='object_path',

1279

connection_keyword='connection')

1364

path_keyword="object_path",

1365

connection_keyword="connection")

1280

1366

def Introspect(self, object_path, connection):

1281

1367

"""Overloading of standard D-Bus method.

1282

1368

1331

1417

document.unlink()

1332

1418

except (AttributeError, xml.dom.DOMException,

1333

1419

xml.parsers.expat.ExpatError) as error:

1334

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

1335

exc_info=error)

1420

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

1421

exc_info=error)

1336

1422

return xmlstring

1337

1423

1338

1424

1396

1482

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

1397

1483

"'ay' signature {!r}"

1398

1484

.format(prop._dbus_signature))

1399

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

1400

for byte in value))

1485

value = dbus.ByteArray(bytes(value))

1401

1486

prop(value)

1402

1487

1403

1488

@dbus.service.method(dbus.PROPERTIES_IFACE,

1436

1521

1437

1522

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1438

1523

out_signature="s",

1439

path_keyword='object_path',

1440

connection_keyword='connection')

1524

path_keyword="object_path",

1525

connection_keyword="connection")

1441

1526

def Introspect(self, object_path, connection):

1442

1527

"""Overloading of standard D-Bus method.

1443

1528

1499

1584

document.unlink()

1500

1585

except (AttributeError, xml.dom.DOMException,

1501

1586

xml.parsers.expat.ExpatError) as error:

1502

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

1503

exc_info=error)

1587

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

1588

exc_info=error)

1504

1589

return xmlstring

1505

1590

1506

1591

1538

1623

1539

1624

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1540

1625

out_signature="s",

1541

path_keyword='object_path',

1542

connection_keyword='connection')

1626

path_keyword="object_path",

1627

connection_keyword="connection")

1543

1628

def Introspect(self, object_path, connection):

1544

1629

"""Overloading of standard D-Bus method.

1545

1630

1570

1655

document.unlink()

1571

1656

except (AttributeError, xml.dom.DOMException,

1572

1657

xml.parsers.expat.ExpatError) as error:

1573

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

1574

exc_info=error)

1658

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

1659

exc_info=error)

1575

1660

return xmlstring

1576

1661

1577

1662

2208

2293

del _interface

2209

2294

2210

2295

2211

class ProxyClient(object):

2296

class ProxyClient:

2212

2297

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

2213

2298

self._pipe = child_pipe

2214

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

2299

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

2215

2300

if not self._pipe.recv():

2216

2301

raise KeyError(key_id or fpr)

2217

2302

2218

2303

def __getattribute__(self, name):

2219

if name == '_pipe':

2304

if name == "_pipe":

2220

2305

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

2221

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

2306

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

2222

2307

data = self._pipe.recv()

2223

if data[0] == 'data':

2308

if data[0] == "data":

2224

2309

return data[1]

2225

if data[0] == 'function':

2310

if data[0] == "function":

2226

2311

2227

2312

def func(*args, **kwargs):

2228

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

2313

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

2229

2314

return self._pipe.recv()[1]

2230

2315

2231

2316

return func

2232

2317

2233

2318

def __setattr__(self, name, value):

2234

if name == '_pipe':

2319

if name == "_pipe":

2235

2320

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

2236

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

2321

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

2237

2322

2238

2323

2239

2324

class ClientHandler(socketserver.BaseRequestHandler, object):

2244

2329

2245

2330

def handle(self):

2246

2331

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

2247

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

2248

str(self.client_address))

2249

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

2250

self.server.child_pipe.fileno())

2332

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

2333

str(self.client_address))

2334

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

2251

2335

2252

2336

session = gnutls.ClientSession(self.request)

2253

2337

2254

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

2338

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

2255

2339

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

2256

2340

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

2257

2341

# "+DHE-DSS"))

2259

2343

priority = self.server.gnutls_priority

2260

2344

if priority is None:

2261

2345

priority = "NORMAL"

2262

gnutls.priority_set_direct(session._c_object,

2263

priority.encode("utf-8"),

2264

None)

2346

gnutls.priority_set_direct(session,

2347

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

2265

2348

2266

2349

# Start communication using the Mandos protocol

2267

2350

# Get protocol number

2268

2351

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

2269

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

2352

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

2270

2353

try:

2271

2354

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

2272

2355

raise RuntimeError(line)

2273

2356

except (ValueError, IndexError, RuntimeError) as error:

2274

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

2357

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

2275

2358

return

2276

2359

2277

2360

# Start GnuTLS connection

2278

2361

try:

2279

2362

session.handshake()

2280

2363

except gnutls.Error as error:

2281

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

2364

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

2282

2365

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

2283

2366

# established. Just abandon the request.

2284

2367

return

2285

logger.debug("Handshake succeeded")

2368

log.debug("Handshake succeeded")

2286

2369

2287

2370

approval_required = False

2288

2371

try:

2289

2372

if gnutls.has_rawpk:

2290

fpr = ""

2373

fpr = b""

2291

2374

try:

2292

2375

key_id = self.key_id(

2293

2376

self.peer_certificate(session))

2294

2377

except (TypeError, gnutls.Error) as error:

2295

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

2378

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

2296

2379

return

2297

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

2380

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

2381

key_id.decode("utf-8",

2382

errors="replace"))

2298

2383

2299

2384

else:

2300

key_id = ""

2385

key_id = b""

2301

2386

try:

2302

2387

fpr = self.fingerprint(

2303

2388

self.peer_certificate(session))

2304

2389

except (TypeError, gnutls.Error) as error:

2305

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

2390

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

2306

2391

return

2307

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

2392

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

2308

2393

2309

2394

try:

2310

2395

client = ProxyClient(child_pipe, key_id, fpr,

2319

2404

2320

2405

while True:

2321

2406

if not client.enabled:

2322

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

2323

client.name)

2407

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

2324

2408

if self.server.use_dbus:

2325

2409

# Emit D-Bus signal

2326

2410

client.Rejected("Disabled")

2330

2414

# We are approved or approval is disabled

2331

2415

break

2332

2416

elif client.approved is None:

2333

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

2334

client.name)

2417

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

2418

client.name)

2335

2419

if self.server.use_dbus:

2336

2420

# Emit D-Bus signal

2337

2421

client.NeedApproval(

2338

2422

client.approval_delay.total_seconds()

2339

2423

* 1000, client.approved_by_default)

2340

2424

else:

2341

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

2342

client.name)

2425

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

2426

client.name)

2343

2427

if self.server.use_dbus:

2344

2428

# Emit D-Bus signal

2345

2429

client.Rejected("Denied")

2353

2437

time2 = datetime.datetime.now()

2354

2438

if (time2 - time) >= delay:

2355

2439

if not client.approved_by_default:

2356

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

2357

" waiting for approval",

2358

client.name)

2440

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

2441

" waiting for approval",

2442

client.name)

2359

2443

if self.server.use_dbus:

2360

2444

# Emit D-Bus signal

2361

2445

client.Rejected("Approval timed out")

2368

2452

try:

2369

2453

session.send(client.secret)

2370

2454

except gnutls.Error as error:

2371

logger.warning("gnutls send failed",

2372

exc_info=error)

2455

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

2373

2456

return

2374

2457

2375

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

2458

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

2376

2459

# bump the timeout using extended_timeout

2377

2460

client.bump_timeout(client.extended_timeout)

2378

2461

if self.server.use_dbus:

2385

2468

try:

2386

2469

session.bye()

2387

2470

except gnutls.Error as error:

2388

logger.warning("GnuTLS bye failed",

2389

exc_info=error)

2471

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

2390

2472

2391

2473

@staticmethod

2392

2474

def peer_certificate(session):

2393

2475

"Return the peer's certificate as a bytestring"

2394

2476

try:

2395

cert_type = gnutls.certificate_type_get2(session._c_object,

2396

gnutls.CTYPE_PEERS)

2477

cert_type = gnutls.certificate_type_get2(

2478

session, gnutls.CTYPE_PEERS)

2397

2479

except AttributeError:

2398

cert_type = gnutls.certificate_type_get(session._c_object)

2480

cert_type = gnutls.certificate_type_get(session)

2399

2481

if gnutls.has_rawpk:

2400

2482

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2401

2483

else:

2402

2484

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2403

2485

# If not a valid certificate type...

2404

2486

if cert_type not in valid_cert_types:

2405

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

2406

valid_cert_types)

2487

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

2488

valid_cert_types)

2407

2489

# ...return invalid data

2408

2490

return b""

2409

2491

list_size = ctypes.c_uint(1)

2410

2492

cert_list = (gnutls.certificate_get_peers

2411

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

2493

(session, ctypes.byref(list_size)))

2412

2494

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

2413

2495

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

2414

2496

if list_size.value == 0:

2436

2518

buf = ctypes.create_string_buffer(32)

2437

2519

buf_len = ctypes.c_size_t(len(buf))

2438

2520

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

2439

gnutls.pubkey_get_key_id(pubkey,

2440

gnutls.KEYID_USE_SHA256,

2441

ctypes.cast(ctypes.byref(buf),

2442

ctypes.POINTER(ctypes.c_ubyte)),

2443

ctypes.byref(buf_len))

2521

gnutls.pubkey_get_key_id(

2522

pubkey,

2523

gnutls.KEYID_USE_SHA256,

2524

ctypes.cast(ctypes.byref(buf),

2525

ctypes.POINTER(ctypes.c_ubyte)),

2526

ctypes.byref(buf_len))

2444

2527

# Deinit the certificate

2445

2528

gnutls.pubkey_deinit(pubkey)

2446

2529

2487

2570

return hex_fpr

2488

2571

2489

2572

2490

class MultiprocessingMixIn(object):

2573

class MultiprocessingMixIn:

2491

2574

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

2492

2575

2493

2576

def sub_process_main(self, request, address):

2505

2588

return proc

2506

2589

2507

2590

2508

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2591

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

2509

2592

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

2510

2593

2511

2594

def process_request(self, request, client_address):

2526

2609

2527

2610

2528

2611

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2529

socketserver.TCPServer, object):

2530

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

2612

socketserver.TCPServer):

2613

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

2531

2614

2532

2615

Attributes:

2533

2616

enabled: Boolean; whether this server is activated yet

2584

2667

if SO_BINDTODEVICE is None:

2585

2668

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

2586

2669

# common enough.

2587

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

2670

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

2588

2671

SO_BINDTODEVICE = 25

2589

2672

try:

2590

2673

self.socket.setsockopt(

2592

2675

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

2593

2676

except socket.error as error:

2594

2677

if error.errno == errno.EPERM:

2595

logger.error("No permission to bind to"

2596

" interface %s", self.interface)

2678

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

2679

self.interface)

2597

2680

elif error.errno == errno.ENOPROTOOPT:

2598

logger.error("SO_BINDTODEVICE not available;"

2599

" cannot bind to interface %s",

2600

self.interface)

2681

log.error("SO_BINDTODEVICE not available; cannot"

2682

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

2601

2683

elif error.errno == errno.ENODEV:

2602

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

2603

" cannot bind", self.interface)

2684

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

2685

" bind", self.interface)

2604

2686

else:

2605

2687

raise

2606

2688

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

2665

2747

def add_pipe(self, parent_pipe, proc):

2666

2748

# Call "handle_ipc" for both data and EOF events

2667

2749

GLib.io_add_watch(

2668

parent_pipe.fileno(),

2669

GLib.IO_IN | GLib.IO_HUP,

2750

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

2751

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

2670

2752

functools.partial(self.handle_ipc,

2671

2753

parent_pipe=parent_pipe,

2672

2754

proc=proc))

2685

2767

request = parent_pipe.recv()

2686

2768

command = request[0]

2687

2769

2688

if command == 'init':

2770

if command == "init":

2689

2771

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

2690

2772

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

2691

2773

address = request[3]

2692

2774

2693

2775

for c in self.clients.values():

2694

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2776

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2777

"27AE41E4649B934CA495991B7852B855"):

2695

2778

continue

2696

2779

if key_id and c.key_id == key_id:

2697

2780

client = c

2700

2783

client = c

2701

2784

break

2702

2785

else:

2703

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

2704

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

2786

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

2787

" %s", key_id or fpr, address)

2705

2788

if self.use_dbus:

2706

2789

# Emit D-Bus signal

2707

2790

mandos_dbus_service.ClientNotFound(key_id or fpr,

2710

2793

return False

2711

2794

2712

2795

GLib.io_add_watch(

2713

parent_pipe.fileno(),

2714

GLib.IO_IN | GLib.IO_HUP,

2796

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

2797

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

2715

2798

functools.partial(self.handle_ipc,

2716

2799

parent_pipe=parent_pipe,

2717

2800

proc=proc,

2720

2803

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

2721

2804

# same fileno

2722

2805

return False

2723

if command == 'funcall':

2806

if command == "funcall":

2724

2807

funcname = request[1]

2725

2808

args = request[2]

2726

2809

kwargs = request[3]

2727

2810

2728

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

2811

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

2729

2812

funcname)(*args,

2730

2813

**kwargs)))

2731

2814

2732

if command == 'getattr':

2815

if command == "getattr":

2733

2816

attrname = request[1]

2734

2817

if isinstance(client_object.__getattribute__(attrname),

2735

collections.Callable):

2736

parent_pipe.send(('function', ))

2818

collections.abc.Callable):

2819

parent_pipe.send(("function", ))

2737

2820

else:

2738

2821

parent_pipe.send((

2739

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

2822

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

2740

2823

2741

if command == 'setattr':

2824

if command == "setattr":

2742

2825

attrname = request[1]

2743

2826

value = request[2]

2744

2827

setattr(client_object, attrname, value)

2749

2832

def rfc3339_duration_to_delta(duration):

2750

2833

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

2751

2834

2752

>>> rfc3339_duration_to_delta("P7D")

2753

datetime.timedelta(7)

2754

>>> rfc3339_duration_to_delta("PT60S")

2755

datetime.timedelta(0, 60)

2756

>>> rfc3339_duration_to_delta("PT60M")

2757

datetime.timedelta(0, 3600)

2758

>>> rfc3339_duration_to_delta("PT24H")

2759

datetime.timedelta(1)

2760

>>> rfc3339_duration_to_delta("P1W")

2761

datetime.timedelta(7)

2762

>>> rfc3339_duration_to_delta("PT5M30S")

2763

datetime.timedelta(0, 330)

2764

>>> rfc3339_duration_to_delta("P1DT3M20S")

2765

datetime.timedelta(1, 200)

2835

>>> timedelta = datetime.timedelta

2836

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

2837

True

2838

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

2839

True

2840

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

2841

True

2842

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

2843

True

2844

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

2845

True

2846

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

2847

True

2848

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

2849

True

2850

>>> del timedelta

2766

2851

"""

2767

2852

2768

2853

# Parsing an RFC 3339 duration with regular expressions is not

2848

2933

def string_to_delta(interval):

2849

2934

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

2850

2935

2851

>>> string_to_delta('7d')

2852

datetime.timedelta(7)

2853

>>> string_to_delta('60s')

2854

datetime.timedelta(0, 60)

2855

>>> string_to_delta('60m')

2856

datetime.timedelta(0, 3600)

2857

>>> string_to_delta('24h')

2858

datetime.timedelta(1)

2859

>>> string_to_delta('1w')

2860

datetime.timedelta(7)

2861

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

2862

datetime.timedelta(0, 330)

2936

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

2937

True

2938

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

2939

True

2940

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

2941

True

2942

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

2943

True

2944

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

2945

True

2946

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

2947

True

2863

2948

"""

2864

2949

2865

2950

try:

2967

3052

2968

3053

options = parser.parse_args()

2969

3054

2970

if options.check:

2971

import doctest

2972

fail_count, test_count = doctest.testmod()

2973

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

2974

2975

3055

# Default values for config file for server-global settings

2976

3056

if gnutls.has_rawpk:

2977

3057

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

2997

3077

del priority

2998

3078

2999

3079

# Parse config file for server-global settings

3000

server_config = configparser.SafeConfigParser(server_defaults)

3080

server_config = configparser.ConfigParser(server_defaults)

3001

3081

del server_defaults

3002

3082

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

3003

# Convert the SafeConfigParser object to a dict

3083

# Convert the ConfigParser object to a dict

3004

3084

server_settings = server_config.defaults()

3005

3085

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

3006

3086

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

3073

3153

3074

3154

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

3075

3155

syslogger.setFormatter(

3076

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

3077

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

3156

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

3157

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

3078

3158

server_settings["servicename"])))

3079

3159

3080

3160

# Parse config file with clients

3081

client_config = configparser.SafeConfigParser(Client

3082

.client_defaults)

3161

client_config = configparser.ConfigParser(Client.client_defaults)

3083

3162

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

3084

3163

"clients.conf"))

3085

3164

3105

3184

try:

3106

3185

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

3107

3186

except IOError as e:

3108

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

3109

exc_info=e)

3187

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

3188

exc_info=e)

3110

3189

3111

3190

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

3112

3191

("mandos", "mandos"),

3123

3202

try:

3124

3203

os.setgid(gid)

3125

3204

os.setuid(uid)

3126

if debug:

3127

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

3128

gid))

3205

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

3129

3206

except OSError as error:

3130

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

3131

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

3207

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

3208

os.strerror(error.errno))

3132

3209

if error.errno != errno.EPERM:

3133

3210

raise

3134

3211

3141

3218

3142

3219

@gnutls.log_func

3143

3220

def debug_gnutls(level, string):

3144

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

3221

log.debug("GnuTLS: %s",

3222

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

3145

3223

3146

3224

gnutls.global_set_log_function(debug_gnutls)

3147

3225

3156

3234

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

3157

3235

daemon()

3158

3236

3159

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

3160

# to inform GLib that threads will be used.

3161

GLib.threads_init()

3237

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

3238

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

3239

# need to inform GLib that threads will be used.

3240

GLib.threads_init()

3162

3241

3163

3242

global main_loop

3164

3243

# From the Avahi example code

3175

3254

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

3176

3255

do_not_queue=True)

3177

3256

except dbus.exceptions.DBusException as e:

3178

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

3257

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

3179

3258

use_dbus = False

3180

3259

server_settings["use_dbus"] = False

3181

3260

tcp_server.use_dbus = False

3240

3319

if isinstance(s, bytes)

3241

3320

else s) for s in

3242

3321

value["client_structure"]]

3243

# .name & .host

3244

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

3322

# .name, .host, and .checker_command

3323

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

3245

3324

if isinstance(value[k], bytes):

3246

3325

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

3247

if not value.has_key("key_id"):

3326

if "key_id" not in value:

3248

3327

value["key_id"] = ""

3249

elif not value.has_key("fingerprint"):

3328

elif "fingerprint" not in value:

3250

3329

value["fingerprint"] = ""

3251

3330

# old_client_settings

3252

3331

# .keys()

3257

3336

for key, value in

3258

3337

bytes_old_client_settings.items()}

3259

3338

del bytes_old_client_settings

3260

# .host

3339

# .host and .checker_command

3261

3340

for value in old_client_settings.values():

3262

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

3263

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

3264

.decode("utf-8"))

3341

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

3342

if isinstance(value[attribute], bytes):

3343

value[attribute] = (value[attribute]

3344

.decode("utf-8"))

3265

3345

os.remove(stored_state_path)

3266

3346

except IOError as e:

3267

3347

if e.errno == errno.ENOENT:

3268

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

3269

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

3348

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

3349

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

3270

3350

else:

3271

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

3272

exc_info=e)

3351

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

3352

exc_info=e)

3273

3353

raise

3274

3354

except EOFError as e:

3275

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

3276

"EOFError:",

3277

exc_info=e)

3355

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

3356

exc_info=e)

3278

3357

3279

3358

with PGPEngine() as pgp:

3280

3359

for client_name, client in clients_data.items():

3307

3386

if client["enabled"]:

3308

3387

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

3309

3388

if not client["last_checked_ok"]:

3310

logger.warning(

3311

"disabling client {} - Client never "

3312

"performed a successful checker".format(

3313

client_name))

3389

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

3390

" never performed a successful"

3391

" checker", client_name)

3314

3392

client["enabled"] = False

3315

3393

elif client["last_checker_status"] != 0:

3316

logger.warning(

3317

"disabling client {} - Client last"

3318

" checker failed with error code"

3319

" {}".format(

3320

client_name,

3321

client["last_checker_status"]))

3394

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

3395

" last checker failed with error"

3396

" code %s", client_name,

3397

client["last_checker_status"])

3322

3398

client["enabled"] = False

3323

3399

else:

3324

3400

client["expires"] = (

3325

3401

datetime.datetime.utcnow()

3326

3402

+ client["timeout"])

3327

logger.debug("Last checker succeeded,"

3328

" keeping {} enabled".format(

3329

client_name))

3403

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

3404

" enabled", client_name)

3330

3405

try:

3331

3406

client["secret"] = pgp.decrypt(

3332

3407

client["encrypted_secret"],

3333

3408

client_settings[client_name]["secret"])

3334

3409

except PGPError:

3335

3410

# If decryption fails, we use secret from new settings

3336

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

3337

client_name))

3411

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

3412

client_name)

3338

3413

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

3339

3414

["secret"])

3340

3415

3354

3429

server_settings=server_settings)

3355

3430

3356

3431

if not tcp_server.clients:

3357

logger.warning("No clients defined")

3432

log.warning("No clients defined")

3358

3433

3359

3434

if not foreground:

3360

3435

if pidfile is not None:

3363

3438

with pidfile:

3364

3439

print(pid, file=pidfile)

3365

3440

except IOError:

3366

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

3367

pidfilename, pid)

3441

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

3442

pidfilename, pid)

3368

3443

del pidfile

3369

3444

del pidfilename

3370

3445

3520

3595

3521

3596

try:

3522

3597

with tempfile.NamedTemporaryFile(

3523

mode='wb',

3598

mode="wb",

3524

3599

suffix=".pickle",

3525

prefix='clients-',

3600

prefix="clients-",

3526

3601

dir=os.path.dirname(stored_state_path),

3527

3602

delete=False) as stored_state:

3528

3603

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

3536

3611

except NameError:

3537

3612

pass

3538

3613

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

3539

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

3540

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

3614

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

3615

os.strerror(e.errno))

3541

3616

else:

3542

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

3543

exc_info=e)

3617

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

3618

exc_info=e)

3544

3619

raise

3545

3620

3546

3621

# Delete all clients, and settings from config

3563

3638

mandos_dbus_service.client_added_signal(client)

3564

3639

# Need to initiate checking of clients

3565

3640

if client.enabled:

3566

client.init_checker()

3641

client.init_checker(randomize_start=True)

3567

3642

3568

3643

tcp_server.enable()

3569

3644

tcp_server.server_activate()

3572

3647

if zeroconf:

3573

3648

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

3574

3649

if use_ipv6:

3575

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

3576

" flowinfo %d, scope_id %d",

3577

*tcp_server.socket.getsockname())

3650

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

3651

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

3578

3652

else: # IPv4

3579

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

3580

*tcp_server.socket.getsockname())

3653

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

3654

*tcp_server.socket.getsockname())

3581

3655

3582

3656

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

3583

3657

3587

3661

try:

3588

3662

service.activate()

3589

3663

except dbus.exceptions.DBusException as error:

3590

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

3664

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

3591

3665

cleanup()

3592

3666

sys.exit(1)

3593

3667

# End of Avahi example code

3594

3668

3595

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

3596

lambda *args, **kwargs:

3597

(tcp_server.handle_request

3598

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

3669

GLib.io_add_watch(

3670

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

3671

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3672

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

3673

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

3599

3674

3600

logger.debug("Starting main loop")

3675

log.debug("Starting main loop")

3601

3676

main_loop.run()

3602

3677

except AvahiError as error:

3603

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

3678

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

3604

3679

cleanup()

3605

3680

sys.exit(1)

3606

3681

except KeyboardInterrupt:

3607

3682

if debug:

3608

3683

print("", file=sys.stderr)

3609

logger.debug("Server received KeyboardInterrupt")

3610

logger.debug("Server exiting")

3684

log.debug("Server received KeyboardInterrupt")

3685

log.debug("Server exiting")

3611

3686

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

3612

3687

cleanup()

3613

3688

3614

3615

if __name__ == '__main__':

3616

main()

3689

3690

def parse_test_args():

3691

# type: () -> argparse.Namespace

3692

parser = argparse.ArgumentParser(add_help=False)

3693

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

3694

parser.add_argument("--prefix", )

3695

args, unknown_args = parser.parse_known_args()

3696

if args.check:

3697

# Remove test options from sys.argv

3698

sys.argv[1:] = unknown_args

3699

return args

3700

3701

# Add all tests from doctest strings

3702

def load_tests(loader, tests, none):

3703

import doctest

3704

tests.addTests(doctest.DocTestSuite())

3705

return tests

3706

3707

if __name__ == "__main__":

3708

options = parse_test_args()

3709

try:

3710

if options.check:

3711

extra_test_prefix = options.prefix

3712

if extra_test_prefix is not None:

3713

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

3714

.result.wasSuccessful()):

3715

sys.exit(1)

3716

class ExtraTestLoader(unittest.TestLoader):

3717

testMethodPrefix = extra_test_prefix

3718

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

3719

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

3720

else:

3721

unittest.main(argv=[""])

3722

else:

3723

main()

3724

finally:

3725

logging.shutdown()

3726

3727

# Local Variables:

3728

# run-tests:

3729

# (lambda (&optional extra)

3730

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

3731

# extra))

3732

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

3733

# (funcall remove-test-window)

3734

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

3735

# run-tests-in-test-buffer:

3736

# (lambda (dir &optional extra)

3737

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

3738

# (setq buffer-read-only nil

3739

# default-directory dir)

3740

# (erase-buffer)

3741

# (compilation-mode))

3742

# (let ((process-result

3743

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

3744

# (process-file-shell-command

3745

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

3746

# (and (numberp process-result)

3747

# (= process-result 0))))

3748

# get-command-line:

3749

# (lambda (&optional extra)

3750

# (let ((quoted-script

3751

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

3752

# (format

3753

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

3754

# quoted-script)))

3755

# get-script-name:

3756

# (lambda ()

3757

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

3758

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

3759

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

3760

# (buffer-file-name))))

3761

# remove-test-window:

3762

# (lambda ()

3763

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

3764

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

3765

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

3766

# (lambda ()

3767

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

3768

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

3769

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

3770

# (display-buffer-overriding-action

3771

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

3772

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

3773

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

3774

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

3775

# eval:

3776

# (progn

3777

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

3778

# (funcall run-tests t)))

3779

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

3780

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

3781

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

3782

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

3783

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

3784

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

3785

# End: