/mandos/trunk : revision 729

1

#!/usr/bin/python

1

#!/usr/bin/python2.7

2

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

3

#

4

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

11

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

12

#

13

# Everything else is

14

15

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

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

from future_builtins import *

38

37

39

import SocketServer as socketserver

38

40

import socket

39

41

import argparse

66

68

import binascii

67

69

import tempfile

68

70

import itertools

71

import collections

69

72

70

73

import dbus

71

74

import dbus.service

76

79

import ctypes.util

77

80

import xml.dom.minidom

78

81

import inspect

79

import GnuPGInterface

80

82

81

83

try:

82

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

86

88

except ImportError:

87

89

SO_BINDTODEVICE = None

88

90

89

version = "1.5.3"

91

version = "1.6.8"

90

92

stored_state_file = "clients.pickle"

91

93

92

94

logger = logging.getLogger()

93

syslogger = (logging.handlers.SysLogHandler

94

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

95

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

95

syslogger = None

96

97

try:

98

if_nametoindex = (ctypes.cdll.LoadLibrary

104

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

105

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

106

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

107

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

108

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

111

109

return interface_index

112

110

113

111

114

112

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

115

113

"""init logger and add loglevel"""

116

114

115

global syslogger

116

syslogger = (logging.handlers.SysLogHandler

117

(facility =

118

logging.handlers.SysLogHandler.LOG_DAEMON,

119

address = "/dev/log"))

117

120

syslogger.setFormatter(logging.Formatter

118

121

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

119

122

' %(message)s'))

137

140

class PGPEngine(object):

138

141

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

139

142

def __init__(self):

140

self.gnupg = GnuPGInterface.GnuPG()

141

143

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

142

self.gnupg = GnuPGInterface.GnuPG()

143

self.gnupg.options.meta_interactive = False

144

self.gnupg.options.homedir = self.tempdir

145

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

146

'--quiet',

147

'--no-use-agent'])

144

self.gnupgargs = ['--batch',

145

'--home', self.tempdir,

146

'--force-mdc',

147

'--quiet',

148

'--no-use-agent']

148

149

150

def __enter__(self):

150

151

return self

151

152

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

153

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

153

154

self._cleanup()

154

155

return False

155

156

172

173

def password_encode(self, password):

173

174

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

174

175

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

175

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

176

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

177

if len(encoded) > 2048:

178

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

179

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

180

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

181

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

182

return encoded

176

183

177

184

def encrypt(self, data, password):

178

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

179

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

180

try:

181

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

182

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

183

attach_fhs={'stderr': devnull})

184

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

185

f.write(data)

186

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

187

ciphertext = f.read()

188

proc.wait()

189

except IOError as e:

190

raise PGPError(e)

191

self.gnupg.passphrase = None

185

passphrase = self.password_encode(password)

186

with tempfile.NamedTemporaryFile(dir=self.tempdir

187

) as passfile:

188

passfile.write(passphrase)

189

passfile.flush()

190

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

191

'--passphrase-file',

192

passfile.name]

193

+ self.gnupgargs,

194

stdin = subprocess.PIPE,

195

stdout = subprocess.PIPE,

196

stderr = subprocess.PIPE)

197

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

198

if proc.returncode != 0:

199

raise PGPError(err)

192

200

return ciphertext

193

201

194

202

def decrypt(self, data, password):

195

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

196

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

197

try:

198

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

199

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

200

attach_fhs={'stderr': devnull})

201

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

202

f.write(data)

203

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

204

decrypted_plaintext = f.read()

205

proc.wait()

206

except IOError as e:

207

raise PGPError(e)

208

self.gnupg.passphrase = None

203

passphrase = self.password_encode(password)

204

with tempfile.NamedTemporaryFile(dir = self.tempdir

205

) as passfile:

206

passfile.write(passphrase)

207

passfile.flush()

208

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

209

'--passphrase-file',

210

passfile.name]

211

+ self.gnupgargs,

212

stdin = subprocess.PIPE,

213

stdout = subprocess.PIPE,

214

stderr = subprocess.PIPE)

215

decrypted_plaintext, err = proc.communicate(input

216

= data)

217

if proc.returncode != 0:

218

raise PGPError(err)

209

219

return decrypted_plaintext

210

220

211

221

212

213

222

class AvahiError(Exception):

214

223

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

215

224

self.value = value

216

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

217

def __unicode__(self):

218

return unicode(repr(self.value))

225

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

226

**kwargs)

219

227

220

228

class AvahiServiceError(AvahiError):

221

229

pass

232

240

Used to optionally bind to the specified interface.

233

241

name: string; Example: 'Mandos'

234

242

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

235

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

243

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

236

244

port: integer; what port to announce

237

245

TXT: list of strings; TXT record for the service

238

246

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

244

252

server: D-Bus Server

245

253

bus: dbus.SystemBus()

246

254

"""

255

247

256

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

248

257

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

249

258

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

262

271

self.server = None

263

272

self.bus = bus

264

273

self.entry_group_state_changed_match = None

274

265

275

def rename(self):

266

276

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

267

277

if self.rename_count >= self.max_renames:

281

291

self.cleanup()

282

292

os._exit(1)

283

293

self.rename_count += 1

294

284

295

def remove(self):

285

296

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

286

297

if self.entry_group_state_changed_match is not None:

288

299

self.entry_group_state_changed_match = None

289

300

if self.group is not None:

290

301

self.group.Reset()

302

291

303

def add(self):

292

304

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

293

305

self.remove()

310

322

dbus.UInt16(self.port),

311

323

avahi.string_array_to_txt_array(self.TXT))

312

324

self.group.Commit()

325

313

326

def entry_group_state_changed(self, state, error):

314

327

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

315

328

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

322

335

elif state == avahi.ENTRY_GROUP_FAILURE:

323

336

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

324

337

unicode(error))

325

raise AvahiGroupError("State changed: %s"

326

% unicode(error))

338

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

339

.format(error))

340

327

341

def cleanup(self):

328

342

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

329

343

if self.group is not None:

334

348

pass

335

349

self.group = None

336

350

self.remove()

351

337

352

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

338

353

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

339

354

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

358

373

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

359

374

else:

360

375

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

376

361

377

def activate(self):

362

378

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

363

379

if self.server is None:

370

386

self.server_state_changed)

371

387

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

372

388

389

373

390

class AvahiServiceToSyslog(AvahiService):

374

391

def rename(self):

375

392

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

376

393

ret = AvahiService.rename(self)

377

394

syslogger.setFormatter(logging.Formatter

378

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

379

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

380

% self.name))

395

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

396

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

397

.format(self.name)))

381

398

return ret

382

399

383

def timedelta_to_milliseconds(td):

384

"Convert a datetime.timedelta() to milliseconds"

385

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

386

+ (td.seconds * 1000)

387

+ (td.microseconds // 1000))

388

400

389

401

class Client(object):

390

402

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

391

403

427

439

runtime_expansions: Allowed attributes for runtime expansion.

428

440

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

429

441

disabled, or None

442

server_settings: The server_settings dict from main()

430

443

"""

431

444

432

445

runtime_expansions = ("approval_delay", "approval_duration",

433

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

434

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

446

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

447

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

448

"last_approval_request", "last_checked_ok",

435

449

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

436

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

437

"extended_timeout": "15m",

438

"interval": "2m",

450

client_defaults = { "timeout": "PT5M",

451

"extended_timeout": "PT15M",

452

"interval": "PT2M",

439

453

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

440

454

"host": "",

441

"approval_delay": "0s",

442

"approval_duration": "1s",

455

"approval_delay": "PT0S",

456

"approval_duration": "PT1S",

443

457

"approved_by_default": "True",

444

458

"enabled": "True",

445

459

}

446

460

447

def timeout_milliseconds(self):

448

"Return the 'timeout' attribute in milliseconds"

449

return timedelta_to_milliseconds(self.timeout)

450

451

def extended_timeout_milliseconds(self):

452

"Return the 'extended_timeout' attribute in milliseconds"

453

return timedelta_to_milliseconds(self.extended_timeout)

454

455

def interval_milliseconds(self):

456

"Return the 'interval' attribute in milliseconds"

457

return timedelta_to_milliseconds(self.interval)

458

459

def approval_delay_milliseconds(self):

460

return timedelta_to_milliseconds(self.approval_delay)

461

462

461

@staticmethod

463

462

def config_parser(config):

464

463

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

489

488

"rb") as secfile:

490

489

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

491

490

else:

492

raise TypeError("No secret or secfile for section %s"

493

% section)

491

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

492

.format(section))

494

493

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

495

494

client["extended_timeout"] = string_to_delta(

496

495

section["extended_timeout"])

505

504

client["last_checker_status"] = -2

506

505

507

506

return settings

508

509

510

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

511

"""Note: the 'checker' key in 'config' sets the

512

'checker_command' attribute and *not* the 'checker'

513

attribute."""

507

508

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

514

509

self.name = name

510

if server_settings is None:

511

server_settings = {}

512

self.server_settings = server_settings

515

513

# adding all client settings

516

for setting, value in settings.iteritems():

514

for setting, value in settings.items():

517

515

setattr(self, setting, value)

518

516

519

517

if self.enabled:

525

523

else:

526

524

self.last_enabled = None

527

525

self.expires = None

528

526

529

527

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

530

528

# Uppercase and remove spaces from fingerprint for later

531

529

# comparison purposes with return value from the fingerprint()

533

531

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

534

532

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

535

533

datetime.datetime.utcnow())

536

534

537

535

# attributes specific for this server instance

538

536

self.checker = None

539

537

self.checker_initiator_tag = None

567

565

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

568

566

# Already enabled

569

567

return

570

self.send_changedstate()

571

568

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

572

569

self.enabled = True

573

570

self.last_enabled = datetime.datetime.utcnow()

574

571

self.init_checker()

572

self.send_changedstate()

575

573

576

574

def disable(self, quiet=True):

577

575

"""Disable this client."""

578

576

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

579

577

return False

580

578

if not quiet:

581

self.send_changedstate()

582

if not quiet:

583

579

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

584

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

580

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

585

581

gobject.source_remove(self.disable_initiator_tag)

586

582

self.disable_initiator_tag = None

587

583

self.expires = None

588

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

584

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

589

585

gobject.source_remove(self.checker_initiator_tag)

590

586

self.checker_initiator_tag = None

591

587

self.stop_checker()

592

588

self.enabled = False

589

if not quiet:

590

self.send_changedstate()

593

591

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

594

592

return False

595

593

599

597

def init_checker(self):

600

598

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

601

599

# and every interval from then on.

600

if self.checker_initiator_tag is not None:

601

gobject.source_remove(self.checker_initiator_tag)

602

self.checker_initiator_tag = (gobject.timeout_add

603

(self.interval_milliseconds(),

603

(int(self.interval

604

.total_seconds() * 1000),

604

605

self.start_checker))

605

606

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

607

if self.disable_initiator_tag is not None:

608

gobject.source_remove(self.disable_initiator_tag)

606

609

self.disable_initiator_tag = (gobject.timeout_add

607

(self.timeout_milliseconds(),

608

self.disable))

610

(int(self.timeout

611

.total_seconds() * 1000),

612

self.disable))

609

613

# Also start a new checker *right now*.

610

614

self.start_checker()

611

615

639

643

timeout = self.timeout

640

644

if self.disable_initiator_tag is not None:

641

645

gobject.source_remove(self.disable_initiator_tag)

646

self.disable_initiator_tag = None

642

647

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

643

648

self.disable_initiator_tag = (gobject.timeout_add

644

(timedelta_to_milliseconds

645

(timeout), self.disable))

649

(int(timeout.total_seconds()

650

* 1000), self.disable))

646

651

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

647

652

648

653

def need_approval(self):

654

659

If a checker already exists, leave it running and do

655

660

nothing."""

656

661

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

657

# did that, then if a checker (for some reason) started

658

# running slowly and taking more than 'interval' time, the

659

# client would inevitably timeout, since no checker would get

660

# a chance to run to completion. If we instead leave running

662

# did that, and if a checker (for some reason) started running

663

# slowly and taking more than 'interval' time, then the client

664

# would inevitably timeout, since no checker would get a

665

# chance to run to completion. If we instead leave running

661

666

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

662

667

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

663

668

# should be.

665

670

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

666

671

try:

667

672

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

668

except (AttributeError, OSError) as error:

669

if (isinstance(error, OSError)

670

and error.errno != errno.ECHILD):

671

raise error

673

except AttributeError:

674

pass

675

except OSError as error:

676

if error.errno != errno.ECHILD:

677

raise

672

678

else:

673

679

if pid:

674

680

logger.warning("Checker was a zombie")

677

683

self.current_checker_command)

678

684

# Start a new checker if needed

679

685

if self.checker is None:

686

# Escape attributes for the shell

687

escaped_attrs = { attr:

688

re.escape(unicode(getattr(self,

689

attr)))

690

for attr in self.runtime_expansions }

680

691

try:

681

# In case checker_command has exactly one % operator

682

command = self.checker_command % self.host

683

except TypeError:

684

# Escape attributes for the shell

685

escaped_attrs = dict(

686

(attr,

687

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

688

errors=

689

'replace')))

690

for attr in

691

self.runtime_expansions)

692

693

try:

694

command = self.checker_command % escaped_attrs

695

except TypeError as error:

696

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

697

self.checker_command, exc_info=error)

698

return True # Try again later

692

command = self.checker_command % escaped_attrs

693

except TypeError as error:

694

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

695

self.checker_command, exc_info=error)

696

return True # Try again later

699

697

self.current_checker_command = command

700

698

try:

701

699

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

704

702

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

705

703

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

706

704

# always replaced by /dev/null.)

705

# The exception is when not debugging but nevertheless

706

# running in the foreground; use the previously

707

# created wnull.

708

popen_args = {}

709

if (not self.server_settings["debug"]

710

and self.server_settings["foreground"]):

711

popen_args.update({"stdout": wnull,

712

"stderr": wnull })

707

713

self.checker = subprocess.Popen(command,

708

714

close_fds=True,

709

shell=True, cwd="/")

710

self.checker_callback_tag = (gobject.child_watch_add

711

(self.checker.pid,

712

self.checker_callback,

713

data=command))

714

# The checker may have completed before the gobject

715

# watch was added. Check for this.

716

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

717

if pid:

718

gobject.source_remove(self.checker_callback_tag)

719

self.checker_callback(pid, status, command)

715

shell=True, cwd="/",

716

**popen_args)

720

717

except OSError as error:

721

718

logger.error("Failed to start subprocess",

722

719

exc_info=error)

720

return True

721

self.checker_callback_tag = (gobject.child_watch_add

722

(self.checker.pid,

723

self.checker_callback,

724

data=command))

725

# The checker may have completed before the gobject

726

# watch was added. Check for this.

727

try:

728

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

729

except OSError as error:

730

if error.errno == errno.ECHILD:

731

# This should never happen

732

logger.error("Child process vanished",

733

exc_info=error)

734

return True

735

raise

736

if pid:

737

gobject.source_remove(self.checker_callback_tag)

738

self.checker_callback(pid, status, command)

723

739

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

724

740

return True

725

741

758

774

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

759

775

if byte_arrays and signature != "ay":

760

776

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

761

" signature %r" % signature)

777

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

762

778

def decorator(func):

763

779

func._dbus_is_property = True

764

780

func._dbus_interface = dbus_interface

773

789

774

790

775

791

def dbus_interface_annotations(dbus_interface):

776

"""Decorator for marking functions returning interface annotations.

792

"""Decorator for marking functions returning interface annotations

777

793

778

794

Usage:

779

795

812

828

class DBusPropertyException(dbus.exceptions.DBusException):

813

829

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

814

830

"""

815

def __unicode__(self):

816

return unicode(str(self))

817

831

pass

818

832

819

833

class DBusPropertyAccessException(DBusPropertyException):

820

834

"""A property's access permissions disallows an operation.

843

857

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

844

858

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

845

859

"""

846

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

860

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

847

861

False)

848

862

849

863

def _get_all_dbus_things(self, thing):

898

912

# The byte_arrays option is not supported yet on

899

913

# signatures other than "ay".

900

914

if prop._dbus_signature != "ay":

901

raise ValueError

915

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

916

"'ay' signature {!r}"

917

.format(prop._dbus_signature))

902

918

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

903

919

for byte in value))

904

920

prop(value)

968

984

(prop,

969

985

"_dbus_annotations",

970

986

{}))

971

for name, value in annots.iteritems():

987

for name, value in annots.items():

972

988

ann_tag = document.createElement(

973

989

"annotation")

974

990

ann_tag.setAttribute("name", name)

976

992

tag.appendChild(ann_tag)

977

993

# Add interface annotation tags

978

994

for annotation, value in dict(

979

itertools.chain(

980

*(annotations().iteritems()

981

for name, annotations in

982

self._get_all_dbus_things("interface")

983

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

984

))).iteritems():

995

itertools.chain.from_iterable(

996

annotations().items()

997

for name, annotations in

998

self._get_all_dbus_things("interface")

999

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

1000

)).items():

985

1001

ann_tag = document.createElement("annotation")

986

1002

ann_tag.setAttribute("name", annotation)

987

1003

ann_tag.setAttribute("value", value)

1010

1026

return xmlstring

1011

1027

1012

1028

1013

def datetime_to_dbus (dt, variant_level=0):

1029

def datetime_to_dbus(dt, variant_level=0):

1014

1030

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

1015

1031

if dt is None:

1016

1032

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

1018

1034

variant_level=variant_level)

1019

1035

1020

1036

1021

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

1022

.__metaclass__):

1023

"""Applied to an empty subclass of a D-Bus object, this metaclass

1024

will add additional D-Bus attributes matching a certain pattern.

1037

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1038

"""A class decorator; applied to a subclass of

1039

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

1040

interface names according to the "alt_interface_names" mapping.

1041

Usage:

1042

1043

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

1044

"net.example.AlternateInterface"})

1045

class SampleDBusObject(dbus.service.Object):

1046

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

1047

def SampleDBusMethod():

1048

pass

1049

1050

The above "SampleDBusMethod" on "SampleDBusObject" will be

1051

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

1052

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

1053

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

1054

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

1055

1056

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

1057

(from DBusObjectWithProperties) and interfaces (from the

1058

dbus_interface_annotations decorator).

1025

1059

"""

1026

def __new__(mcs, name, bases, attr):

1027

# Go through all the base classes which could have D-Bus

1028

# methods, signals, or properties in them

1029

old_interface_names = []

1030

for base in (b for b in bases

1031

if issubclass(b, dbus.service.Object)):

1032

# Go though all attributes of the base class

1033

for attrname, attribute in inspect.getmembers(base):

1060

def wrapper(cls):

1061

for orig_interface_name, alt_interface_name in (

1062

alt_interface_names.items()):

1063

attr = {}

1064

interface_names = set()

1065

# Go though all attributes of the class

1066

for attrname, attribute in inspect.getmembers(cls):

1034

1067

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

1035

1068

# with the wrong interface name

1036

1069

if (not hasattr(attribute, "_dbus_interface")

1037

1070

or not attribute._dbus_interface

1038

.startswith("se.recompile.Mandos")):

1071

.startswith(orig_interface_name)):

1039

1072

continue

1040

1073

# Create an alternate D-Bus interface name based on

1041

1074

# the current name

1042

1075

alt_interface = (attribute._dbus_interface

1043

.replace("se.recompile.Mandos",

1044

"se.bsnet.fukt.Mandos"))

1045

if alt_interface != attribute._dbus_interface:

1046

old_interface_names.append(alt_interface)

1076

.replace(orig_interface_name,

1077

alt_interface_name))

1078

interface_names.add(alt_interface)

1047

1079

# Is this a D-Bus signal?

1048

1080

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

1049

# Extract the original non-method function by

1050

# black magic

1081

# Extract the original non-method undecorated

1082

# function by black magic

1051

1083

nonmethod_func = (dict(

1052

1084

zip(attribute.func_code.co_freevars,

1053

1085

attribute.__closure__))["func"]

1071

1103

except AttributeError:

1072

1104

pass

1073

1105

# Define a creator of a function to call both the

1074

# old and new functions, so both the old and new

1075

# signals gets sent when the function is called

1106

# original and alternate functions, so both the

1107

# original and alternate signals gets sent when

1108

# the function is called

1076

1109

def fixscope(func1, func2):

1077

1110

"""This function is a scope container to pass

1078

1111

func1 and func2 to the "call_both" function

1085

1118

return call_both

1086

1119

# Create the "call_both" function and add it to

1087

1120

# the class

1088

attr[attrname] = fixscope(attribute,

1089

new_function)

1121

attr[attrname] = fixscope(attribute, new_function)

1090

1122

# Is this a D-Bus method?

1091

1123

elif getattr(attribute, "_dbus_is_method", False):

1092

1124

# Create a new, but exactly alike, function

1148

1180

attribute.func_name,

1149

1181

attribute.func_defaults,

1150

1182

attribute.func_closure)))

1151

# Deprecate all old interfaces

1152

basename="_AlternateDBusNamesMetaclass_interface_annotation{0}"

1153

for old_interface_name in old_interface_names:

1154

@dbus_interface_annotations(old_interface_name)

1155

def func(self):

1156

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

1157

# Find an unused name

1158

for aname in (basename.format(i) for i in

1159

itertools.count()):

1160

if aname not in attr:

1161

attr[aname] = func

1162

break

1163

return type.__new__(mcs, name, bases, attr)

1164

1165

1183

if deprecate:

1184

# Deprecate all alternate interfaces

1185

iname="_AlternateDBusNames_interface_annotation{}"

1186

for interface_name in interface_names:

1187

@dbus_interface_annotations(interface_name)

1188

def func(self):

1189

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

1190

"true" }

1191

# Find an unused name

1192

for aname in (iname.format(i)

1193

for i in itertools.count()):

1194

if aname not in attr:

1195

attr[aname] = func

1196

break

1197

if interface_names:

1198

# Replace the class with a new subclass of it with

1199

# methods, signals, etc. as created above.

1200

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

1201

(cls,), attr)

1202

return cls

1203

return wrapper

1204

1205

1206

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

1207

"se.bsnet.fukt.Mandos"})

1166

1208

class ClientDBus(Client, DBusObjectWithProperties):

1167

1209

"""A Client class using D-Bus

1168

1210

1188

1230

("/clients/" + client_object_name))

1189

1231

DBusObjectWithProperties.__init__(self, self.bus,

1190

1232

self.dbus_object_path)

1191

1233

1192

1234

def notifychangeproperty(transform_func,

1193

1235

dbus_name, type_func=lambda x: x,

1194

1236

variant_level=1):

1202

1244

to the D-Bus. Default: no transform

1203

1245

variant_level: D-Bus variant level. Default: 1

1204

1246

"""

1205

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

1247

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

1206

1248

def setter(self, value):

1207

1249

if hasattr(self, "dbus_object_path"):

1208

1250

if (not hasattr(self, attrname) or

1217

1259

1218

1260

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

1219

1261

1220

1221

1262

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1222

1263

approvals_pending = notifychangeproperty(dbus.Boolean,

1223

1264

"ApprovalPending",

1239

1280

approval_delay = notifychangeproperty(dbus.UInt64,

1240

1281

"ApprovalDelay",

1241

1282

type_func =

1242

timedelta_to_milliseconds)

1283

lambda td: td.total_seconds()

1284

* 1000)

1243

1285

approval_duration = notifychangeproperty(

1244

1286

dbus.UInt64, "ApprovalDuration",

1245

type_func = timedelta_to_milliseconds)

1287

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

1246

1288

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

1247

1289

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

1248

type_func =

1249

timedelta_to_milliseconds)

1290

type_func = lambda td:

1291

td.total_seconds() * 1000)

1250

1292

extended_timeout = notifychangeproperty(

1251

1293

dbus.UInt64, "ExtendedTimeout",

1252

type_func = timedelta_to_milliseconds)

1294

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

1253

1295

interval = notifychangeproperty(dbus.UInt64,

1254

1296

"Interval",

1255

1297

type_func =

1256

timedelta_to_milliseconds)

1298

lambda td: td.total_seconds()

1299

* 1000)

1257

1300

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

1258

1301

1259

1302

del notifychangeproperty

1287

1330

*args, **kwargs)

1288

1331

1289

1332

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

1290

old_checker = self.checker

1291

if self.checker is not None:

1292

old_checker_pid = self.checker.pid

1293

else:

1294

old_checker_pid = None

1333

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

1295

1334

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

1296

1335

# Only if new checker process was started

1297

1336

if (self.checker is not None

1305

1344

return False

1306

1345

1307

1346

def approve(self, value=True):

1308

self.send_changedstate()

1309

1347

self.approved = value

1310

gobject.timeout_add(timedelta_to_milliseconds

1311

(self.approval_duration),

1312

self._reset_approved)

1313

1348

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

1349

* 1000), self._reset_approved)

1350

self.send_changedstate()

1314

1351

1315

1352

## D-Bus methods, signals & properties

1316

1353

_interface = "se.recompile.Mandos.Client"

1418

1455

access="readwrite")

1419

1456

def ApprovalDelay_dbus_property(self, value=None):

1420

1457

if value is None: # get

1421

return dbus.UInt64(self.approval_delay_milliseconds())

1458

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

1459

* 1000)

1422

1460

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

1423

1461

1424

1462

# ApprovalDuration - property

1426

1464

access="readwrite")

1427

1465

def ApprovalDuration_dbus_property(self, value=None):

1428

1466

if value is None: # get

1429

return dbus.UInt64(timedelta_to_milliseconds(

1430

self.approval_duration))

1467

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

1468

* 1000)

1431

1469

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

1432

1470

1433

1471

# Name - property

1499

1537

access="readwrite")

1500

1538

def Timeout_dbus_property(self, value=None):

1501

1539

if value is None: # get

1502

return dbus.UInt64(self.timeout_milliseconds())

1540

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

1541

old_timeout = self.timeout

1503

1542

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

1504

# Reschedule timeout

1543

# Reschedule disabling

1505

1544

if self.enabled:

1506

1545

now = datetime.datetime.utcnow()

1507

time_to_die = timedelta_to_milliseconds(

1508

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

1509

if time_to_die <= 0:

1546

self.expires += self.timeout - old_timeout

1547

if self.expires <= now:

1510

1548

# The timeout has passed

1511

1549

self.disable()

1512

1550

else:

1513

self.expires = (now +

1514

datetime.timedelta(milliseconds =

1515

time_to_die))

1516

1551

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

1517

1552

is None):

1518

1553

return

1519

1554

gobject.source_remove(self.disable_initiator_tag)

1520

self.disable_initiator_tag = (gobject.timeout_add

1521

(time_to_die,

1522

self.disable))

1555

self.disable_initiator_tag = (

1556

gobject.timeout_add(

1557

int((self.expires - now).total_seconds()

1558

* 1000), self.disable))

1523

1559

1524

1560

# ExtendedTimeout - property

1525

1561

@dbus_service_property(_interface, signature="t",

1526

1562

access="readwrite")

1527

1563

def ExtendedTimeout_dbus_property(self, value=None):

1528

1564

if value is None: # get

1529

return dbus.UInt64(self.extended_timeout_milliseconds())

1565

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

1566

* 1000)

1530

1567

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

1531

1568

1532

1569

# Interval - property

1534

1571

access="readwrite")

1535

1572

def Interval_dbus_property(self, value=None):

1536

1573

if value is None: # get

1537

return dbus.UInt64(self.interval_milliseconds())

1574

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

1538

1575

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

1539

1576

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

1540

1577

return

1573

1610

@dbus_service_property(_interface, signature="ay",

1574

1611

access="write", byte_arrays=True)

1575

1612

def Secret_dbus_property(self, value):

1576

self.secret = str(value)

1613

self.secret = bytes(value)

1577

1614

1578

1615

del _interface

1579

1616

1604

1641

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

1605

1642

1606

1643

1607

class ClientDBusTransitional(ClientDBus):

1608

__metaclass__ = AlternateDBusNamesMetaclass

1609

1610

1611

1644

class ClientHandler(socketserver.BaseRequestHandler, object):

1612

1645

"""A class to handle client connections.

1613

1646

1649

1682

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

1650

1683

try:

1651

1684

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

1652

raise RuntimeError

1685

raise RuntimeError(line)

1653

1686

except (ValueError, IndexError, RuntimeError) as error:

1654

1687

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

1655

1688

return

1704

1737

if self.server.use_dbus:

1705

1738

# Emit D-Bus signal

1706

1739

client.NeedApproval(

1707

client.approval_delay_milliseconds(),

1708

client.approved_by_default)

1740

client.approval_delay.total_seconds()

1741

* 1000, client.approved_by_default)

1709

1742

else:

1710

1743

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

1711

1744

client.name)

1717

1750

#wait until timeout or approved

1718

1751

time = datetime.datetime.now()

1719

1752

client.changedstate.acquire()

1720

(client.changedstate.wait

1721

(float(client.timedelta_to_milliseconds(delay)

1722

/ 1000)))

1753

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

1723

1754

client.changedstate.release()

1724

1755

time2 = datetime.datetime.now()

1725

1756

if (time2 - time) >= delay:

1741

1772

try:

1742

1773

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

1743

1774

except gnutls.errors.GNUTLSError as error:

1744

logger.warning("gnutls send failed")

1775

logger.warning("gnutls send failed",

1776

exc_info=error)

1745

1777

return

1746

1778

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

1747

1779

sent, len(client.secret)

1761

1793

try:

1762

1794

session.bye()

1763

1795

except gnutls.errors.GNUTLSError as error:

1764

logger.warning("GnuTLS bye failed")

1796

logger.warning("GnuTLS bye failed",

1797

exc_info=error)

1765

1798

1766

1799

@staticmethod

1767

1800

def peer_certificate(session):

1839

1872

def process_request(self, request, address):

1840

1873

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

1841

1874

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

1842

args = (request,

1843

address))

1875

args = (request, address))

1844

1876

proc.start()

1845

1877

return proc

1846

1878

1861

1893

1862

1894

def add_pipe(self, parent_pipe, proc):

1863

1895

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

1864

raise NotImplementedError

1896

raise NotImplementedError()

1865

1897

1866

1898

1867

1899

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1874

1906

use_ipv6: Boolean; to use IPv6 or not

1875

1907

"""

1876

1908

def __init__(self, server_address, RequestHandlerClass,

1877

interface=None, use_ipv6=True):

1909

interface=None, use_ipv6=True, socketfd=None):

1910

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

1911

creating a new one with socket.socket().

1912

"""

1878

1913

self.interface = interface

1879

1914

if use_ipv6:

1880

1915

self.address_family = socket.AF_INET6

1916

if socketfd is not None:

1917

# Save the file descriptor

1918

self.socketfd = socketfd

1919

# Save the original socket.socket() function

1920

self.socket_socket = socket.socket

1921

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

1922

#

1923

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

1924

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

1925

# patching socket.socket.)

1926

#

1927

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

1928

@functools.wraps(socket.socket)

1929

def socket_wrapper(*args, **kwargs):

1930

# Restore original function so subsequent calls are

1931

# not affected.

1932

socket.socket = self.socket_socket

1933

del self.socket_socket

1934

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

1935

# saved file descriptor.

1936

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

1937

# Replace socket.socket() function with wrapper

1938

socket.socket = socket_wrapper

1939

# The socketserver.TCPServer.__init__ will call

1940

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

1941

# socket_wrapper(), if socketfd was set.

1881

1942

socketserver.TCPServer.__init__(self, server_address,

1882

1943

RequestHandlerClass)

1944

1883

1945

def server_bind(self):

1884

1946

"""This overrides the normal server_bind() function

1885

1947

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

1893

1955

try:

1894

1956

self.socket.setsockopt(socket.SOL_SOCKET,

1895

1957

SO_BINDTODEVICE,

1896

str(self.interface

1897

+ '\0'))

1958

(self.interface + "\0")

1959

.encode("utf-8"))

1898

1960

except socket.error as error:

1899

if error[0] == errno.EPERM:

1900

logger.error("No permission to"

1901

" bind to interface %s",

1902

self.interface)

1903

elif error[0] == errno.ENOPROTOOPT:

1961

if error.errno == errno.EPERM:

1962

logger.error("No permission to bind to"

1963

" interface %s", self.interface)

1964

elif error.errno == errno.ENOPROTOOPT:

1904

1965

logger.error("SO_BINDTODEVICE not available;"

1905

1966

" cannot bind to interface %s",

1906

1967

self.interface)

1968

elif error.errno == errno.ENODEV:

1969

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

1970

" cannot bind", self.interface)

1907

1971

else:

1908

1972

raise

1909

1973

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

1912

1976

if self.address_family == socket.AF_INET6:

1913

1977

any_address = "::" # in6addr_any

1914

1978

else:

1915

any_address = socket.INADDR_ANY

1979

any_address = "0.0.0.0" # INADDR_ANY

1916

1980

self.server_address = (any_address,

1917

1981

self.server_address[1])

1918

1982

elif not self.server_address[1]:

1939

2003

"""

1940

2004

def __init__(self, server_address, RequestHandlerClass,

1941

2005

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

1942

gnutls_priority=None, use_dbus=True):

2006

gnutls_priority=None, use_dbus=True, socketfd=None):

1943

2007

self.enabled = False

1944

2008

self.clients = clients

1945

2009

if self.clients is None:

1949

2013

IPv6_TCPServer.__init__(self, server_address,

1950

2014

RequestHandlerClass,

1951

2015

interface = interface,

1952

use_ipv6 = use_ipv6)

2016

use_ipv6 = use_ipv6,

2017

socketfd = socketfd)

1953

2018

def server_activate(self):

1954

2019

if self.enabled:

1955

2020

return socketserver.TCPServer.server_activate(self)

1968

2033

1969

2034

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

1970

2035

proc = None, client_object=None):

1971

condition_names = {

1972

gobject.IO_IN: "IN", # There is data to read.

1973

gobject.IO_OUT: "OUT", # Data can be written (without

1974

# blocking).

1975

gobject.IO_PRI: "PRI", # There is urgent data to read.

1976

gobject.IO_ERR: "ERR", # Error condition.

1977

gobject.IO_HUP: "HUP" # Hung up (the connection has been

1978

# broken, usually for pipes and

1979

# sockets).

1980

}

1981

conditions_string = ' | '.join(name

1982

for cond, name in

1983

condition_names.iteritems()

1984

if cond & condition)

1985

2036

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

1986

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

2037

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

1987

2038

# Wait for other process to exit

1988

2039

proc.join()

1989

2040

return False

2047

2098

return True

2048

2099

2049

2100

2101

def rfc3339_duration_to_delta(duration):

2102

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

2103

2104

>>> rfc3339_duration_to_delta("P7D")

2105

datetime.timedelta(7)

2106

>>> rfc3339_duration_to_delta("PT60S")

2107

datetime.timedelta(0, 60)

2108

>>> rfc3339_duration_to_delta("PT60M")

2109

datetime.timedelta(0, 3600)

2110

>>> rfc3339_duration_to_delta("PT24H")

2111

datetime.timedelta(1)

2112

>>> rfc3339_duration_to_delta("P1W")

2113

datetime.timedelta(7)

2114

>>> rfc3339_duration_to_delta("PT5M30S")

2115

datetime.timedelta(0, 330)

2116

>>> rfc3339_duration_to_delta("P1DT3M20S")

2117

datetime.timedelta(1, 200)

2118

"""

2119

2120

# Parsing an RFC 3339 duration with regular expressions is not

2121

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

2122

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

2123

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

2124

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

2125

# avoid excessive use of external libraries.

2126

2127

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

2128

Token = collections.namedtuple("Token",

2129

("regexp", # To match token; if

2130

# "value" is not None,

2131

# must have a "group"

2132

# containing digits

2133

"value", # datetime.timedelta or

2134

# None

2135

"followers")) # Tokens valid after

2136

# this token

2137

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

2138

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

2139

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

2140

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

2141

datetime.timedelta(seconds=1),

2142

frozenset((token_end,)))

2143

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

2144

datetime.timedelta(minutes=1),

2145

frozenset((token_second, token_end)))

2146

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

2147

datetime.timedelta(hours=1),

2148

frozenset((token_minute, token_end)))

2149

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

2150

None,

2151

frozenset((token_hour, token_minute,

2152

token_second)))

2153

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

2154

datetime.timedelta(days=1),

2155

frozenset((token_time, token_end)))

2156

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

2157

datetime.timedelta(weeks=4),

2158

frozenset((token_day, token_end)))

2159

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

2160

datetime.timedelta(weeks=52),

2161

frozenset((token_month, token_end)))

2162

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

2163

datetime.timedelta(weeks=1),

2164

frozenset((token_end,)))

2165

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

2166

frozenset((token_year, token_month,

2167

token_day, token_time,

2168

token_week)))

2169

# Define starting values

2170

value = datetime.timedelta() # Value so far

2171

found_token = None

2172

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

2173

s = duration # String left to parse

2174

# Loop until end token is found

2175

while found_token is not token_end:

2176

# Search for any currently valid tokens

2177

for token in followers:

2178

match = token.regexp.match(s)

2179

if match is not None:

2180

# Token found

2181

if token.value is not None:

2182

# Value found, parse digits

2183

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

2184

# Add to value so far

2185

value += factor * token.value

2186

# Strip token from string

2187

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

2188

# Go to found token

2189

found_token = token

2190

# Set valid next tokens

2191

followers = found_token.followers

2192

break

2193

else:

2194

# No currently valid tokens were found

2195

raise ValueError("Invalid RFC 3339 duration")

2196

# End token found

2197

return value

2198

2199

2050

2200

def string_to_delta(interval):

2051

2201

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

2052

2202

2063

2213

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

2064

2214

datetime.timedelta(0, 330)

2065

2215

"""

2216

2217

try:

2218

return rfc3339_duration_to_delta(interval)

2219

except ValueError:

2220

pass

2221

2066

2222

timevalue = datetime.timedelta(0)

2067

2223

for s in interval.split():

2068

2224

try:

2069

suffix = unicode(s[-1])

2225

suffix = s[-1]

2070

2226

value = int(s[:-1])

2071

2227

if suffix == "d":

2072

2228

delta = datetime.timedelta(value)

2079

2235

elif suffix == "w":

2080

2236

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

2081

2237

else:

2082

raise ValueError("Unknown suffix %r" % suffix)

2083

except (ValueError, IndexError) as e:

2238

raise ValueError("Unknown suffix {!r}"

2239

.format(suffix))

2240

except IndexError as e:

2084

2241

raise ValueError(*(e.args))

2085

2242

timevalue += delta

2086

2243

return timevalue

2101

2258

# Close all standard open file descriptors

2102

2259

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

2103

2260

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

2104

raise OSError(errno.ENODEV,

2105

"%s not a character device"

2106

% os.devnull)

2261

raise OSError(errno.ENODEV, "{} not a character device"

2262

.format(os.devnull))

2107

2263

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

2108

2264

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

2109

2265

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

2118

2274

2119

2275

parser = argparse.ArgumentParser()

2120

2276

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

2121

version = "%%(prog)s %s" % version,

2277

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

2122

2278

help="show version number and exit")

2123

2279

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

2124

2280

help="Bind to interface IF")

2130

2286

help="Run self-test")

2131

2287

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

2132

2288

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

2133

" to terminal")

2289

" to terminal", default=None)

2134

2290

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

2135

2291

help="Debug level for stdout output")

2136

2292

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

2143

2299

" files")

2144

2300

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

2145

2301

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

2146

" system bus interface")

2302

" system bus interface", default=None)

2147

2303

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

2148

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

2304

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

2305

default=None)

2149

2306

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

2150

2307

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

2151

" state")

2308

" state", default=None)

2309

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

2310

help="Specify a file descriptor to a network"

2311

" socket to use instead of creating one")

2152

2312

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

2153

2313

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

2314

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

2315

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

2316

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

2317

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

2318

default=None)

2154

2319

2155

2320

options = parser.parse_args()

2156

2321

2157

2322

if options.check:

2158

2323

import doctest

2159

doctest.testmod()

2160

sys.exit()

2324

fail_count, test_count = doctest.testmod()

2325

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

2161

2326

2162

2327

# Default values for config file for server-global settings

2163

2328

server_defaults = { "interface": "",

2165

2330

"port": "",

2166

2331

"debug": "False",

2167

2332

"priority":

2168

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

2333

"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",

2169

2334

"servicename": "Mandos",

2170

2335

"use_dbus": "True",

2171

2336

"use_ipv6": "True",

2172

2337

"debuglevel": "",

2173

2338

"restore": "True",

2174

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

2339

"socket": "",

2340

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

2341

"foreground": "False",

2342

"zeroconf": "True",

2175

2343

}

2176

2344

2177

2345

# Parse config file for server-global settings

2182

2350

# Convert the SafeConfigParser object to a dict

2183

2351

server_settings = server_config.defaults()

2184

2352

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

2185

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

2353

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

2186

2354

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

2187

2355

option)

2188

2356

if server_settings["port"]:

2189

2357

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

2190

2358

"port")

2359

if server_settings["socket"]:

2360

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

2361

"socket")

2362

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

2363

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

2364

# happen with a supplied network socket.

2365

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

2366

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

2367

["socket"])

2191

2368

del server_config

2192

2369

2193

2370

# Override the settings from the config file with command line

2195

2372

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

2196

2373

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

2197

2374

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

2198

"statedir"):

2375

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

2199

2376

value = getattr(options, option)

2200

2377

if value is not None:

2201

2378

server_settings[option] = value

2202

2379

del options

2203

2380

# Force all strings to be unicode

2204

2381

for option in server_settings.keys():

2205

if type(server_settings[option]) is str:

2206

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

2382

if isinstance(server_settings[option], bytes):

2383

server_settings[option] = (server_settings[option]

2384

.decode("utf-8"))

2385

# Force all boolean options to be boolean

2386

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

2387

"foreground", "zeroconf"):

2388

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

2389

# Debug implies foreground

2390

if server_settings["debug"]:

2391

server_settings["foreground"] = True

2207

2392

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

2208

2393

2209

2394

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

2210

2395

2396

if (not server_settings["zeroconf"] and

2397

not (server_settings["port"]

2398

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

2399

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

2400

" Zeroconf")

2401

2211

2402

# For convenience

2212

2403

debug = server_settings["debug"]

2213

2404

debuglevel = server_settings["debuglevel"]

2215

2406

use_ipv6 = server_settings["use_ipv6"]

2216

2407

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

2217

2408

stored_state_file)

2409

foreground = server_settings["foreground"]

2410

zeroconf = server_settings["zeroconf"]

2218

2411

2219

2412

if debug:

2220

2413

initlogger(debug, logging.DEBUG)

2227

2420

2228

2421

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

2229

2422

syslogger.setFormatter(logging.Formatter

2230

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

2231

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

2232

% server_settings["servicename"]))

2423

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

2424

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

2425

.format(server_settings

2426

["servicename"])))

2233

2427

2234

2428

# Parse config file with clients

2235

2429

client_config = configparser.SafeConfigParser(Client

2240

2434

global mandos_dbus_service

2241

2435

mandos_dbus_service = None

2242

2436

2437

socketfd = None

2438

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

2439

socketfd = server_settings["socket"]

2243

2440

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

2244

2441

server_settings["port"]),

2245

2442

ClientHandler,

2248

2445

use_ipv6=use_ipv6,

2249

2446

gnutls_priority=

2250

2447

server_settings["priority"],

2251

use_dbus=use_dbus)

2252

if not debug:

2253

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

2448

use_dbus=use_dbus,

2449

socketfd=socketfd)

2450

if not foreground:

2451

pidfilename = "/run/mandos.pid"

2452

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

2453

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

2454

pidfile = None

2254

2455

try:

2255

2456

pidfile = open(pidfilename, "w")

2256

except IOError:

2257

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

2457

except IOError as e:

2458

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

2459

exc_info=e)

2258

2460

2259

try:

2260

uid = pwd.getpwnam("_mandos").pw_uid

2261

gid = pwd.getpwnam("_mandos").pw_gid

2262

except KeyError:

2461

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

2263

2462

try:

2264

uid = pwd.getpwnam("mandos").pw_uid

2265

gid = pwd.getpwnam("mandos").pw_gid

2463

uid = pwd.getpwnam(name).pw_uid

2464

gid = pwd.getpwnam(name).pw_gid

2465

break

2266

2466

except KeyError:

2267

try:

2268

uid = pwd.getpwnam("nobody").pw_uid

2269

gid = pwd.getpwnam("nobody").pw_gid

2270

except KeyError:

2271

uid = 65534

2272

gid = 65534

2467

continue

2468

else:

2469

uid = 65534

2470

gid = 65534

2273

2471

try:

2274

2472

os.setgid(gid)

2275

2473

os.setuid(uid)

2276

2474

except OSError as error:

2277

if error[0] != errno.EPERM:

2278

raise error

2475

if error.errno != errno.EPERM:

2476

raise

2279

2477

2280

2478

if debug:

2281

2479

# Enable all possible GnuTLS debugging

2298

2496

os.close(null)

2299

2497

2300

2498

# Need to fork before connecting to D-Bus

2301

if not debug:

2499

if not foreground:

2302

2500

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

2303

2501

daemon()

2304

2502

2503

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

2504

# need to inform gobject that threads will be used.

2305

2505

gobject.threads_init()

2306

2506

2307

2507

global main_loop

2318

2518

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

2319

2519

do_not_queue=True))

2320

2520

except dbus.exceptions.NameExistsException as e:

2321

logger.error(unicode(e) + ", disabling D-Bus")

2521

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

2322

2522

use_dbus = False

2323

2523

server_settings["use_dbus"] = False

2324

2524

tcp_server.use_dbus = False

2325

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2326

service = AvahiServiceToSyslog(name =

2327

server_settings["servicename"],

2328

servicetype = "_mandos._tcp",

2329

protocol = protocol, bus = bus)

2330

if server_settings["interface"]:

2331

service.interface = (if_nametoindex

2332

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

2525

if zeroconf:

2526

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2527

service = AvahiServiceToSyslog(name =

2528

server_settings["servicename"],

2529

servicetype = "_mandos._tcp",

2530

protocol = protocol, bus = bus)

2531

if server_settings["interface"]:

2532

service.interface = (if_nametoindex

2533

(server_settings["interface"]

2534

.encode("utf-8")))

2333

2535

2334

2536

global multiprocessing_manager

2335

2537

multiprocessing_manager = multiprocessing.Manager()

2336

2538

2337

2539

client_class = Client

2338

2540

if use_dbus:

2339

client_class = functools.partial(ClientDBusTransitional,

2340

bus = bus)

2541

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

2341

2542

2342

2543

client_settings = Client.config_parser(client_config)

2343

2544

old_client_settings = {}

2344

2545

clients_data = {}

2345

2546

2547

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

2548

global wnull

2549

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

2550

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

2551

# mode

2552

if debug or not foreground:

2553

wnull.close()

2554

2346

2555

# Get client data and settings from last running state.

2347

2556

if server_settings["restore"]:

2348

2557

try:

2351

2560

(stored_state))

2352

2561

os.remove(stored_state_path)

2353

2562

except IOError as e:

2354

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

2355

.format(e))

2356

if e.errno != errno.ENOENT:

2563

if e.errno == errno.ENOENT:

2564

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

2565

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

2566

else:

2567

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

2568

exc_info=e)

2357

2569

raise

2358

2570

except EOFError as e:

2359

2571

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

2360

"EOFError: {0}".format(e))

2572

"EOFError:", exc_info=e)

2361

2573

2362

2574

with PGPEngine() as pgp:

2363

for client_name, client in clients_data.iteritems():

2575

for client_name, client in clients_data.items():

2576

# Skip removed clients

2577

if client_name not in client_settings:

2578

continue

2579

2364

2580

# Decide which value to use after restoring saved state.

2365

2581

# We have three different values: Old config file,

2366

2582

# new config file, and saved state.

2387

2603

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

2388

2604

if not client["last_checked_ok"]:

2389

2605

logger.warning(

2390

"disabling client {0} - Client never "

2606

"disabling client {} - Client never "

2391

2607

"performed a successful checker"

2392

2608

.format(client_name))

2393

2609

client["enabled"] = False

2394

2610

elif client["last_checker_status"] != 0:

2395

2611

logger.warning(

2396

"disabling client {0} - Client "

2397

"last checker failed with error code {1}"

2612

"disabling client {} - Client last"

2613

" checker failed with error code {}"

2398

2614

.format(client_name,

2399

2615

client["last_checker_status"]))

2400

2616

client["enabled"] = False

2403

2619

.utcnow()

2404

2620

+ client["timeout"])

2405

2621

logger.debug("Last checker succeeded,"

2406

" keeping {0} enabled"

2622

" keeping {} enabled"

2407

2623

.format(client_name))

2408

2624

try:

2409

2625

client["secret"] = (

2412

2628

["secret"]))

2413

2629

except PGPError:

2414

2630

# If decryption fails, we use secret from new settings

2415

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

2631

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

2416

2632

.format(client_name))

2417

2633

client["secret"] = (

2418

2634

client_settings[client_name]["secret"])

2419

2420

2635

2421

2636

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

2422

2637

for client_name in (set(old_client_settings)

2425

2640

for client_name in (set(client_settings)

2426

2641

- set(old_client_settings)):

2427

2642

clients_data[client_name] = client_settings[client_name]

2428

2643

2429

2644

# Create all client objects

2430

for client_name, client in clients_data.iteritems():

2645

for client_name, client in clients_data.items():

2431

2646

tcp_server.clients[client_name] = client_class(

2432

name = client_name, settings = client)

2647

name = client_name, settings = client,

2648

server_settings = server_settings)

2433

2649

2434

2650

if not tcp_server.clients:

2435

2651

logger.warning("No clients defined")

2436

2437

if not debug:

2438

try:

2439

with pidfile:

2440

pid = os.getpid()

2441

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

2442

del pidfile

2443

except IOError:

2444

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

2445

pidfilename, pid)

2446

except NameError:

2447

# "pidfile" was never created

2448

pass

2652

2653

if not foreground:

2654

if pidfile is not None:

2655

try:

2656

with pidfile:

2657

pid = os.getpid()

2658

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

2659

except IOError:

2660

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

2661

pidfilename, pid)

2662

del pidfile

2449

2663

del pidfilename

2450

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

2451

2664

2452

2665

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

2453

2666

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

2454

2667

2455

2668

if use_dbus:

2669

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

2670

"se.bsnet.fukt.Mandos"})

2456

2671

class MandosDBusService(DBusObjectWithProperties):

2457

2672

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

2458

2673

def __init__(self):

2512

2727

2513

2728

del _interface

2514

2729

2515

class MandosDBusServiceTransitional(MandosDBusService):

2516

__metaclass__ = AlternateDBusNamesMetaclass

2517

mandos_dbus_service = MandosDBusServiceTransitional()

2730

mandos_dbus_service = MandosDBusService()

2518

2731

2519

2732

def cleanup():

2520

2733

"Cleanup function; run on exit"

2521

service.cleanup()

2734

if zeroconf:

2735

service.cleanup()

2522

2736

2523

2737

multiprocessing.active_children()

2738

wnull.close()

2524

2739

if not (tcp_server.clients or client_settings):

2525

2740

return

2526

2741

2537

2752

2538

2753

# A list of attributes that can not be pickled

2539

2754

# + secret.

2540

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

2541

"checker"))

2755

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

2756

"checker", "server_settings" }

2542

2757

for name, typ in (inspect.getmembers

2543

2758

(dbus.service.Object)):

2544

2759

exclude.add(name)

2553

2768

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

2554

2769

2555

2770

try:

2556

tempfd, tempname = tempfile.mkstemp(suffix=".pickle",

2557

prefix="clients-",

2558

dir=os.path.dirname

2559

(stored_state_path))

2560

with os.fdopen(tempfd, "wb") as stored_state:

2771

with (tempfile.NamedTemporaryFile

2772

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

2773

dir=os.path.dirname(stored_state_path),

2774

delete=False)) as stored_state:

2561

2775

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

2776

tempname=stored_state.name

2562

2777

os.rename(tempname, stored_state_path)

2563

2778

except (IOError, OSError) as e:

2564

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

2565

.format(e))

2566

2779

if not debug:

2567

2780

try:

2568

2781

os.remove(tempname)

2569

2782

except NameError:

2570

2783

pass

2571

if e.errno not in set((errno.ENOENT, errno.EACCES,

2572

errno.EEXIST)):

2573

raise e

2784

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

2785

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

2786

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

2787

else:

2788

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

2789

exc_info=e)

2790

raise

2574

2791

2575

2792

# Delete all clients, and settings from config

2576

2793

while tcp_server.clients:

2600

2817

tcp_server.server_activate()

2601

2818

2602

2819

# Find out what port we got

2603

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

2820

if zeroconf:

2821

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

2604

2822

if use_ipv6:

2605

2823

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

2606

" flowinfo %d, scope_id %d"

2607

% tcp_server.socket.getsockname())

2824

" flowinfo %d, scope_id %d",

2825

*tcp_server.socket.getsockname())

2608

2826

else: # IPv4

2609

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

2610

% tcp_server.socket.getsockname())

2827

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

2828

*tcp_server.socket.getsockname())

2611

2829

2612

2830

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

2613

2831

2614

2832

try:

2615

# From the Avahi example code

2616

try:

2617

service.activate()

2618

except dbus.exceptions.DBusException as error:

2619

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

2620

cleanup()

2621

sys.exit(1)

2622

# End of Avahi example code

2833

if zeroconf:

2834

# From the Avahi example code

2835

try:

2836

service.activate()

2837

except dbus.exceptions.DBusException as error:

2838

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

2839

cleanup()

2840

sys.exit(1)

2841

# End of Avahi example code

2623

2842

2624

2843

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

2625

2844

lambda *args, **kwargs: