/mandos/trunk : revision 654

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

90

92

stored_state_file = "clients.pickle"

91

93

92

94

logger = logging.getLogger()

137

139

class PGPEngine(object):

138

140

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

139

141

def __init__(self):

140

self.gnupg = GnuPGInterface.GnuPG()

141

142

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'])

143

self.gnupgargs = ['--batch',

144

'--home', self.tempdir,

145

'--force-mdc',

146

'--quiet',

147

'--no-use-agent']

148

149

def __enter__(self):

150

return self

151

152

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

152

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

153

self._cleanup()

154

return False

155

172

def password_encode(self, password):

173

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

174

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

175

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

175

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

176

if len(encoded) > 2048:

177

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

178

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

179

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

180

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

181

return encoded

176

182

177

183

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

184

passphrase = self.password_encode(password)

185

with tempfile.NamedTemporaryFile(dir=self.tempdir

186

) as passfile:

187

passfile.write(passphrase)

188

passfile.flush()

189

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

190

'--passphrase-file',

191

passfile.name]

192

+ self.gnupgargs,

193

stdin = subprocess.PIPE,

194

stdout = subprocess.PIPE,

195

stderr = subprocess.PIPE)

196

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

197

if proc.returncode != 0:

198

raise PGPError(err)

192

199

return ciphertext

193

200

194

201

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

202

passphrase = self.password_encode(password)

203

with tempfile.NamedTemporaryFile(dir = self.tempdir

204

) as passfile:

205

passfile.write(passphrase)

206

passfile.flush()

207

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

208

'--passphrase-file',

209

passfile.name]

210

+ self.gnupgargs,

211

stdin = subprocess.PIPE,

212

stdout = subprocess.PIPE,

213

stderr = subprocess.PIPE)

214

decrypted_plaintext, err = proc.communicate(input

215

= data)

216

if proc.returncode != 0:

217

raise PGPError(err)

209

218

return decrypted_plaintext

210

219

211

220

231

240

Used to optionally bind to the specified interface.

232

241

name: string; Example: 'Mandos'

233

242

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

234

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

243

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

235

244

port: integer; what port to announce

236

245

TXT: list of strings; TXT record for the service

237

246

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

377

386

self.server_state_changed)

378

387

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

379

388

389

380

390

class AvahiServiceToSyslog(AvahiService):

381

391

def rename(self):

382

392

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

387

397

.format(self.name)))

388

398

return ret

389

399

400

390

401

def timedelta_to_milliseconds(td):

391

402

"Convert a datetime.timedelta() to milliseconds"

392

403

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

393

404

+ (td.seconds * 1000)

394

405

+ (td.microseconds // 1000))

395

406

407

396

408

class Client(object):

397

409

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

398

410

434

446

runtime_expansions: Allowed attributes for runtime expansion.

435

447

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

436

448

disabled, or None

449

server_settings: The server_settings dict from main()

437

450

"""

438

451

439

452

runtime_expansions = ("approval_delay", "approval_duration",

440

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

441

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

453

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

454

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

455

"last_approval_request", "last_checked_ok",

442

456

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

443

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

444

"extended_timeout": "15m",

445

"interval": "2m",

457

client_defaults = { "timeout": "PT5M",

458

"extended_timeout": "PT15M",

459

"interval": "PT2M",

446

460

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

447

461

"host": "",

448

"approval_delay": "0s",

449

"approval_duration": "1s",

462

"approval_delay": "PT0S",

463

"approval_duration": "PT1S",

450

464

"approved_by_default": "True",

451

465

"enabled": "True",

452

466

}

513

527

514

528

return settings

515

529

516

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

530

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

517

531

self.name = name

532

if server_settings is None:

533

server_settings = {}

534

self.server_settings = server_settings

518

535

# adding all client settings

519

536

for setting, value in settings.iteritems():

520

537

setattr(self, setting, value)

570

587

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

571

588

# Already enabled

572

589

return

573

self.send_changedstate()

574

590

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

575

591

self.enabled = True

576

592

self.last_enabled = datetime.datetime.utcnow()

577

593

self.init_checker()

594

self.send_changedstate()

578

595

579

596

def disable(self, quiet=True):

580

597

"""Disable this client."""

581

598

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

582

599

return False

583

600

if not quiet:

584

self.send_changedstate()

585

if not quiet:

586

601

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

587

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

602

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

588

603

gobject.source_remove(self.disable_initiator_tag)

589

604

self.disable_initiator_tag = None

590

605

self.expires = None

591

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

606

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

592

607

gobject.source_remove(self.checker_initiator_tag)

593

608

self.checker_initiator_tag = None

594

609

self.stop_checker()

595

610

self.enabled = False

611

if not quiet:

612

self.send_changedstate()

596

613

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

597

614

return False

598

615

602

619

def init_checker(self):

603

620

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

604

621

# and every interval from then on.

622

if self.checker_initiator_tag is not None:

623

gobject.source_remove(self.checker_initiator_tag)

605

624

self.checker_initiator_tag = (gobject.timeout_add

606

625

(self.interval_milliseconds(),

607

626

self.start_checker))

608

627

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

628

if self.disable_initiator_tag is not None:

629

gobject.source_remove(self.disable_initiator_tag)

609

630

self.disable_initiator_tag = (gobject.timeout_add

610

631

(self.timeout_milliseconds(),

611

632

self.disable))

642

663

timeout = self.timeout

643

664

if self.disable_initiator_tag is not None:

644

665

gobject.source_remove(self.disable_initiator_tag)

666

self.disable_initiator_tag = None

645

667

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

646

668

self.disable_initiator_tag = (gobject.timeout_add

647

669

(timedelta_to_milliseconds

657

679

If a checker already exists, leave it running and do

658

680

nothing."""

659

681

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

660

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

661

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

662

# client would inevitably timeout, since no checker would get

663

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

682

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

683

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

684

# would inevitably timeout, since no checker would get a

685

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

664

686

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

665

687

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

666

688

# should be.

668

690

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

669

691

try:

670

692

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

671

except (AttributeError, OSError) as error:

672

if (isinstance(error, OSError)

673

and error.errno != errno.ECHILD):

674

raise error

693

except AttributeError:

694

pass

695

except OSError as error:

696

if error.errno != errno.ECHILD:

697

raise

675

698

else:

676

699

if pid:

677

700

logger.warning("Checker was a zombie")

680

703

self.current_checker_command)

681

704

# Start a new checker if needed

682

705

if self.checker is None:

706

# Escape attributes for the shell

707

escaped_attrs = dict(

708

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

709

for attr in

710

self.runtime_expansions)

683

711

try:

684

# In case checker_command has exactly one % operator

685

command = self.checker_command % self.host

686

except TypeError:

687

# Escape attributes for the shell

688

escaped_attrs = dict(

689

(attr,

690

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

691

errors=

692

'replace')))

693

for attr in

694

self.runtime_expansions)

695

696

try:

697

command = self.checker_command % escaped_attrs

698

except TypeError as error:

699

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

700

self.checker_command, exc_info=error)

701

return True # Try again later

712

command = self.checker_command % escaped_attrs

713

except TypeError as error:

714

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

715

self.checker_command, exc_info=error)

716

return True # Try again later

702

717

self.current_checker_command = command

703

718

try:

704

719

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

707

722

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

708

723

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

709

724

# always replaced by /dev/null.)

725

# The exception is when not debugging but nevertheless

726

# running in the foreground; use the previously

727

# created wnull.

728

popen_args = {}

729

if (not self.server_settings["debug"]

730

and self.server_settings["foreground"]):

731

popen_args.update({"stdout": wnull,

732

"stderr": wnull })

710

733

self.checker = subprocess.Popen(command,

711

734

close_fds=True,

712

shell=True, cwd="/")

713

self.checker_callback_tag = (gobject.child_watch_add

714

(self.checker.pid,

715

self.checker_callback,

716

data=command))

717

# The checker may have completed before the gobject

718

# watch was added. Check for this.

719

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

720

if pid:

721

gobject.source_remove(self.checker_callback_tag)

722

self.checker_callback(pid, status, command)

735

shell=True, cwd="/",

736

**popen_args)

723

737

except OSError as error:

724

738

logger.error("Failed to start subprocess",

725

739

exc_info=error)

740

return True

741

self.checker_callback_tag = (gobject.child_watch_add

742

(self.checker.pid,

743

self.checker_callback,

744

data=command))

745

# The checker may have completed before the gobject

746

# watch was added. Check for this.

747

try:

748

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

749

except OSError as error:

750

if error.errno == errno.ECHILD:

751

# This should never happen

752

logger.error("Child process vanished",

753

exc_info=error)

754

return True

755

raise

756

if pid:

757

gobject.source_remove(self.checker_callback_tag)

758

self.checker_callback(pid, status, command)

726

759

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

727

760

return True

728

761

901

934

# The byte_arrays option is not supported yet on

902

935

# signatures other than "ay".

903

936

if prop._dbus_signature != "ay":

904

raise ValueError

937

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

938

"'ay' signature {0!r}"

939

.format(prop._dbus_signature))

905

940

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

906

941

for byte in value))

907

942

prop(value)

979

1014

tag.appendChild(ann_tag)

980

1015

# Add interface annotation tags

981

1016

for annotation, value in dict(

982

itertools.chain(

983

*(annotations().iteritems()

984

for name, annotations in

985

self._get_all_dbus_things("interface")

986

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

987

))).iteritems():

1017

itertools.chain.from_iterable(

1018

annotations().iteritems()

1019

for name, annotations in

1020

self._get_all_dbus_things("interface")

1021

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

1022

)).iteritems():

988

1023

ann_tag = document.createElement("annotation")

989

1024

ann_tag.setAttribute("name", annotation)

990

1025

ann_tag.setAttribute("value", value)

1013

1048

return xmlstring

1014

1049

1015

1050

1016

def datetime_to_dbus (dt, variant_level=0):

1051

def datetime_to_dbus(dt, variant_level=0):

1017

1052

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

1018

1053

if dt is None:

1019

1054

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

1021

1056

variant_level=variant_level)

1022

1057

1023

1058

1024

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

1025

.__metaclass__):

1026

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

1027

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

1059

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1060

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

1061

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

1062

interface names according to the "alt_interface_names" mapping.

1063

Usage:

1064

1065

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

1066

"net.example.AlternateInterface"})

1067

class SampleDBusObject(dbus.service.Object):

1068

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

1069

def SampleDBusMethod():

1070

pass

1071

1072

The above "SampleDBusMethod" on "SampleDBusObject" will be

1073

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

1074

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

1075

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

1076

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

1077

1078

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

1079

(from DBusObjectWithProperties) and interfaces (from the

1080

dbus_interface_annotations decorator).

1028

1081

"""

1029

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

1030

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

1031

# methods, signals, or properties in them

1032

old_interface_names = []

1033

for base in (b for b in bases

1034

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

1035

# Go though all attributes of the base class

1036

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

1082

def wrapper(cls):

1083

for orig_interface_name, alt_interface_name in (

1084

alt_interface_names.iteritems()):

1085

attr = {}

1086

interface_names = set()

1087

# Go though all attributes of the class

1088

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

1037

1089

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

1038

1090

# with the wrong interface name

1039

1091

if (not hasattr(attribute, "_dbus_interface")

1040

1092

or not attribute._dbus_interface

1041

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

1093

.startswith(orig_interface_name)):

1042

1094

continue

1043

1095

# Create an alternate D-Bus interface name based on

1044

1096

# the current name

1045

1097

alt_interface = (attribute._dbus_interface

1046

.replace("se.recompile.Mandos",

1047

"se.bsnet.fukt.Mandos"))

1048

if alt_interface != attribute._dbus_interface:

1049

old_interface_names.append(alt_interface)

1098

.replace(orig_interface_name,

1099

alt_interface_name))

1100

interface_names.add(alt_interface)

1050

1101

# Is this a D-Bus signal?

1051

1102

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

1052

# Extract the original non-method function by

1053

# black magic

1103

# Extract the original non-method undecorated

1104

# function by black magic

1054

1105

nonmethod_func = (dict(

1055

1106

zip(attribute.func_code.co_freevars,

1056

1107

attribute.__closure__))["func"]

1074

1125

except AttributeError:

1075

1126

pass

1076

1127

# Define a creator of a function to call both the

1077

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

1078

# signals gets sent when the function is called

1128

# original and alternate functions, so both the

1129

# original and alternate signals gets sent when

1130

# the function is called

1079

1131

def fixscope(func1, func2):

1080

1132

"""This function is a scope container to pass

1081

1133

func1 and func2 to the "call_both" function

1088

1140

return call_both

1089

1141

# Create the "call_both" function and add it to

1090

1142

# the class

1091

attr[attrname] = fixscope(attribute,

1092

new_function)

1143

attr[attrname] = fixscope(attribute, new_function)

1093

1144

# Is this a D-Bus method?

1094

1145

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

1095

1146

# Create a new, but exactly alike, function

1151

1202

attribute.func_name,

1152

1203

attribute.func_defaults,

1153

1204

attribute.func_closure)))

1154

# Deprecate all old interfaces

1155

iname="_AlternateDBusNamesMetaclass_interface_annotation{0}"

1156

for old_interface_name in old_interface_names:

1157

@dbus_interface_annotations(old_interface_name)

1158

def func(self):

1159

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

1160

# Find an unused name

1161

for aname in (iname.format(i) for i in itertools.count()):

1162

if aname not in attr:

1163

attr[aname] = func

1164

break

1165

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

1166

1167

1205

if deprecate:

1206

# Deprecate all alternate interfaces

1207

iname="_AlternateDBusNames_interface_annotation{0}"

1208

for interface_name in interface_names:

1209

@dbus_interface_annotations(interface_name)

1210

def func(self):

1211

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

1212

"true" }

1213

# Find an unused name

1214

for aname in (iname.format(i)

1215

for i in itertools.count()):

1216

if aname not in attr:

1217

attr[aname] = func

1218

break

1219

if interface_names:

1220

# Replace the class with a new subclass of it with

1221

# methods, signals, etc. as created above.

1222

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

1223

(cls,), attr)

1224

return cls

1225

return wrapper

1226

1227

1228

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

1229

"se.bsnet.fukt.Mandos"})

1168

1230

class ClientDBus(Client, DBusObjectWithProperties):

1169

1231

"""A Client class using D-Bus

1170

1232

1306

1368

return False

1307

1369

1308

1370

def approve(self, value=True):

1309

self.send_changedstate()

1310

1371

self.approved = value

1311

1372

gobject.timeout_add(timedelta_to_milliseconds

1312

1373

(self.approval_duration),

1313

1374

self._reset_approved)

1375

self.send_changedstate()

1314

1376

1315

1377

## D-Bus methods, signals & properties

1316

1378

_interface = "se.recompile.Mandos.Client"

1500

1562

def Timeout_dbus_property(self, value=None):

1501

1563

if value is None: # get

1502

1564

return dbus.UInt64(self.timeout_milliseconds())

1565

old_timeout = self.timeout

1503

1566

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

1504

# Reschedule timeout

1567

# Reschedule disabling

1505

1568

if self.enabled:

1506

1569

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:

1570

self.expires += self.timeout - old_timeout

1571

if self.expires <= now:

1510

1572

# The timeout has passed

1511

1573

self.disable()

1512

1574

else:

1513

self.expires = (now +

1514

datetime.timedelta(milliseconds =

1515

time_to_die))

1516

1575

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

1517

1576

is None):

1518

1577

return

1519

1578

gobject.source_remove(self.disable_initiator_tag)

1520

self.disable_initiator_tag = (gobject.timeout_add

1521

(time_to_die,

1522

self.disable))

1579

self.disable_initiator_tag = (

1580

gobject.timeout_add(

1581

timedelta_to_milliseconds(self.expires - now),

1582

self.disable))

1523

1583

1524

1584

# ExtendedTimeout - property

1525

1585

@dbus_service_property(_interface, signature="t",

1604

1664

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

1605

1665

1606

1666

1607

class ClientDBusTransitional(ClientDBus):

1608

__metaclass__ = AlternateDBusNamesMetaclass

1609

1610

1611

1667

class ClientHandler(socketserver.BaseRequestHandler, object):

1612

1668

"""A class to handle client connections.

1613

1669

1649

1705

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

1650

1706

try:

1651

1707

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

1652

raise RuntimeError

1708

raise RuntimeError(line)

1653

1709

except (ValueError, IndexError, RuntimeError) as error:

1654

1710

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

1655

1711

return

1717

1773

#wait until timeout or approved

1718

1774

time = datetime.datetime.now()

1719

1775

client.changedstate.acquire()

1720

(client.changedstate.wait

1721

(float(client.timedelta_to_milliseconds(delay)

1722

/ 1000)))

1776

client.changedstate.wait(

1777

float(timedelta_to_milliseconds(delay)

1778

/ 1000))

1723

1779

client.changedstate.release()

1724

1780

time2 = datetime.datetime.now()

1725

1781

if (time2 - time) >= delay:

1841

1897

def process_request(self, request, address):

1842

1898

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

1843

1899

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

1844

args = (request,

1845

address))

1900

args = (request, address))

1846

1901

proc.start()

1847

1902

return proc

1848

1903

1863

1918

1864

1919

def add_pipe(self, parent_pipe, proc):

1865

1920

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

1866

raise NotImplementedError

1921

raise NotImplementedError()

1867

1922

1868

1923

1869

1924

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1876

1931

use_ipv6: Boolean; to use IPv6 or not

1877

1932

"""

1878

1933

def __init__(self, server_address, RequestHandlerClass,

1879

interface=None, use_ipv6=True):

1934

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

1935

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

1936

creating a new one with socket.socket().

1937

"""

1880

1938

self.interface = interface

1881

1939

if use_ipv6:

1882

1940

self.address_family = socket.AF_INET6

1941

if socketfd is not None:

1942

# Save the file descriptor

1943

self.socketfd = socketfd

1944

# Save the original socket.socket() function

1945

self.socket_socket = socket.socket

1946

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

1947

#

1948

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

1949

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

1950

# patching socket.socket.)

1951

#

1952

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

1953

@functools.wraps(socket.socket)

1954

def socket_wrapper(*args, **kwargs):

1955

# Restore original function so subsequent calls are

1956

# not affected.

1957

socket.socket = self.socket_socket

1958

del self.socket_socket

1959

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

1960

# saved file descriptor.

1961

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

1962

# Replace socket.socket() function with wrapper

1963

socket.socket = socket_wrapper

1964

# The socketserver.TCPServer.__init__ will call

1965

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

1966

# socket_wrapper(), if socketfd was set.

1883

1967

socketserver.TCPServer.__init__(self, server_address,

1884

1968

RequestHandlerClass)

1969

1885

1970

def server_bind(self):

1886

1971

"""This overrides the normal server_bind() function

1887

1972

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

1895

1980

try:

1896

1981

self.socket.setsockopt(socket.SOL_SOCKET,

1897

1982

SO_BINDTODEVICE,

1898

str(self.interface

1899

+ '\0'))

1983

str(self.interface + '\0'))

1900

1984

except socket.error as error:

1901

if error[0] == errno.EPERM:

1902

logger.error("No permission to"

1903

" bind to interface %s",

1904

self.interface)

1905

elif error[0] == errno.ENOPROTOOPT:

1985

if error.errno == errno.EPERM:

1986

logger.error("No permission to bind to"

1987

" interface %s", self.interface)

1988

elif error.errno == errno.ENOPROTOOPT:

1906

1989

logger.error("SO_BINDTODEVICE not available;"

1907

1990

" cannot bind to interface %s",

1908

1991

self.interface)

1992

elif error.errno == errno.ENODEV:

1993

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

1994

" cannot bind", self.interface)

1909

1995

else:

1910

1996

raise

1911

1997

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

1914

2000

if self.address_family == socket.AF_INET6:

1915

2001

any_address = "::" # in6addr_any

1916

2002

else:

1917

any_address = socket.INADDR_ANY

2003

any_address = "0.0.0.0" # INADDR_ANY

1918

2004

self.server_address = (any_address,

1919

2005

self.server_address[1])

1920

2006

elif not self.server_address[1]:

1941

2027

"""

1942

2028

def __init__(self, server_address, RequestHandlerClass,

1943

2029

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

1944

gnutls_priority=None, use_dbus=True):

2030

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

1945

2031

self.enabled = False

1946

2032

self.clients = clients

1947

2033

if self.clients is None:

1951

2037

IPv6_TCPServer.__init__(self, server_address,

1952

2038

RequestHandlerClass,

1953

2039

interface = interface,

1954

use_ipv6 = use_ipv6)

2040

use_ipv6 = use_ipv6,

2041

socketfd = socketfd)

1955

2042

def server_activate(self):

1956

2043

if self.enabled:

1957

2044

return socketserver.TCPServer.server_activate(self)

1970

2057

1971

2058

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

1972

2059

proc = None, client_object=None):

1973

condition_names = {

1974

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

1975

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

1976

# blocking).

1977

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

1978

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

1979

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

1980

# broken, usually for pipes and

1981

# sockets).

1982

}

1983

conditions_string = ' | '.join(name

1984

for cond, name in

1985

condition_names.iteritems()

1986

if cond & condition)

1987

2060

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

1988

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

2061

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

1989

2062

# Wait for other process to exit

1990

2063

proc.join()

1991

2064

return False

2049

2122

return True

2050

2123

2051

2124

2125

def rfc3339_duration_to_delta(duration):

2126

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

2127

2128

>>> rfc3339_duration_to_delta("P7D")

2129

datetime.timedelta(7)

2130

>>> rfc3339_duration_to_delta("PT60S")

2131

datetime.timedelta(0, 60)

2132

>>> rfc3339_duration_to_delta("PT60M")

2133

datetime.timedelta(0, 3600)

2134

>>> rfc3339_duration_to_delta("PT24H")

2135

datetime.timedelta(1)

2136

>>> rfc3339_duration_to_delta("P1W")

2137

datetime.timedelta(7)

2138

>>> rfc3339_duration_to_delta("PT5M30S")

2139

datetime.timedelta(0, 330)

2140

>>> rfc3339_duration_to_delta("P1DT3M20S")

2141

datetime.timedelta(1, 200)

2142

"""

2143

2144

# Parsing an RFC 3339 duration with regular expressions is not

2145

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

2146

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

2147

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

2148

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

2149

# avoid excessive use of external libraries.

2150

2151

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

2152

Token = collections.namedtuple("Token",

2153

("regexp", # To match token; if

2154

# "value" is not None,

2155

# must have a "group"

2156

# containing digits

2157

"value", # datetime.timedelta or

2158

# None

2159

"followers")) # Tokens valid after

2160

# this token

2161

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

2162

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

2163

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

2164

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

2165

datetime.timedelta(seconds=1),

2166

frozenset((token_end,)))

2167

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

2168

datetime.timedelta(minutes=1),

2169

frozenset((token_second, token_end)))

2170

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

2171

datetime.timedelta(hours=1),

2172

frozenset((token_minute, token_end)))

2173

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

2174

None,

2175

frozenset((token_hour, token_minute,

2176

token_second)))

2177

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

2178

datetime.timedelta(days=1),

2179

frozenset((token_time, token_end)))

2180

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

2181

datetime.timedelta(weeks=4),

2182

frozenset((token_day, token_end)))

2183

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

2184

datetime.timedelta(weeks=52),

2185

frozenset((token_month, token_end)))

2186

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

2187

datetime.timedelta(weeks=1),

2188

frozenset((token_end,)))

2189

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

2190

frozenset((token_year, token_month,

2191

token_day, token_time,

2192

token_week))),

2193

# Define starting values

2194

value = datetime.timedelta() # Value so far

2195

found_token = None

2196

followers = frozenset(token_duration,) # Following valid tokens

2197

s = duration # String left to parse

2198

# Loop until end token is found

2199

while found_token is not token_end:

2200

# Search for any currently valid tokens

2201

for token in followers:

2202

match = token.regexp.match(s)

2203

if match is not None:

2204

# Token found

2205

if token.value is not None:

2206

# Value found, parse digits

2207

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

2208

# Add to value so far

2209

value += factor * token.value

2210

# Strip token from string

2211

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

2212

# Go to found token

2213

found_token = token

2214

# Set valid next tokens

2215

followers = found_token.followers

2216

break

2217

else:

2218

# No currently valid tokens were found

2219

raise ValueError("Invalid RFC 3339 duration")

2220

# End token found

2221

return value

2222

2223

2052

2224

def string_to_delta(interval):

2053

2225

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

2054

2226

2065

2237

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

2066

2238

datetime.timedelta(0, 330)

2067

2239

"""

2240

2241

try:

2242

return rfc3339_duration_to_delta(interval)

2243

except ValueError:

2244

pass

2245

2068

2246

timevalue = datetime.timedelta(0)

2069

2247

for s in interval.split():

2070

2248

try:

2083

2261

else:

2084

2262

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

2085

2263

.format(suffix))

2086

except (ValueError, IndexError) as e:

2264

except IndexError as e:

2087

2265

raise ValueError(*(e.args))

2088

2266

timevalue += delta

2089

2267

return timevalue

2133

2311

help="Run self-test")

2134

2312

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

2135

2313

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

2136

" to terminal")

2314

" to terminal", default=None)

2137

2315

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

2138

2316

help="Debug level for stdout output")

2139

2317

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

2146

2324

" files")

2147

2325

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

2148

2326

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

2149

" system bus interface")

2327

" system bus interface", default=None)

2150

2328

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

2151

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

2329

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

2330

default=None)

2152

2331

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

2153

2332

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

2154

" state")

2333

" state", default=None)

2334

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

2335

help="Specify a file descriptor to a network"

2336

" socket to use instead of creating one")

2155

2337

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

2156

2338

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

2339

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

2340

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

2157

2341

2158

2342

options = parser.parse_args()

2159

2343

2160

2344

if options.check:

2161

2345

import doctest

2162

doctest.testmod()

2163

sys.exit()

2346

fail_count, test_count = doctest.testmod()

2347

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

2164

2348

2165

2349

# Default values for config file for server-global settings

2166

2350

server_defaults = { "interface": "",

2168

2352

"port": "",

2169

2353

"debug": "False",

2170

2354

"priority":

2171

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

2355

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

2172

2356

"servicename": "Mandos",

2173

2357

"use_dbus": "True",

2174

2358

"use_ipv6": "True",

2175

2359

"debuglevel": "",

2176

2360

"restore": "True",

2177

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

2361

"socket": "",

2362

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

2363

"foreground": "False",

2178

2364

}

2179

2365

2180

2366

# Parse config file for server-global settings

2185

2371

# Convert the SafeConfigParser object to a dict

2186

2372

server_settings = server_config.defaults()

2187

2373

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

2188

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

2374

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

2189

2375

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

2190

2376

option)

2191

2377

if server_settings["port"]:

2192

2378

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

2193

2379

"port")

2380

if server_settings["socket"]:

2381

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

2382

"socket")

2383

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

2384

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

2385

# happen with a supplied network socket.

2386

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

2387

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

2388

["socket"])

2194

2389

del server_config

2195

2390

2196

2391

# Override the settings from the config file with command line

2198

2393

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

2199

2394

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

2200

2395

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

2201

"statedir"):

2396

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

2202

2397

value = getattr(options, option)

2203

2398

if value is not None:

2204

2399

server_settings[option] = value

2207

2402

for option in server_settings.keys():

2208

2403

if type(server_settings[option]) is str:

2209

2404

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

2405

# Force all boolean options to be boolean

2406

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

2407

"foreground"):

2408

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

2409

# Debug implies foreground

2410

if server_settings["debug"]:

2411

server_settings["foreground"] = True

2210

2412

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

2211

2413

2212

2414

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

2218

2420

use_ipv6 = server_settings["use_ipv6"]

2219

2421

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

2220

2422

stored_state_file)

2423

foreground = server_settings["foreground"]

2221

2424

2222

2425

if debug:

2223

2426

initlogger(debug, logging.DEBUG)

2252

2455

use_ipv6=use_ipv6,

2253

2456

gnutls_priority=

2254

2457

server_settings["priority"],

2255

use_dbus=use_dbus)

2256

if not debug:

2257

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

2458

use_dbus=use_dbus,

2459

socketfd=(server_settings["socket"]

2460

or None))

2461

if not foreground:

2462

pidfilename = "/run/mandos.pid"

2463

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

2464

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

2465

pidfile = None

2258

2466

try:

2259

2467

pidfile = open(pidfilename, "w")

2260

2468

except IOError as e:

2275

2483

os.setgid(gid)

2276

2484

os.setuid(uid)

2277

2485

except OSError as error:

2278

if error[0] != errno.EPERM:

2279

raise error

2486

if error.errno != errno.EPERM:

2487

raise

2280

2488

2281

2489

if debug:

2282

2490

# Enable all possible GnuTLS debugging

2299

2507

os.close(null)

2300

2508

2301

2509

# Need to fork before connecting to D-Bus

2302

if not debug:

2510

if not foreground:

2303

2511

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

2304

2512

daemon()

2305

2513

2514

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

2515

# need to inform gobject that threads will be used.

2306

2516

gobject.threads_init()

2307

2517

2308

2518

global main_loop

2337

2547

2338

2548

client_class = Client

2339

2549

if use_dbus:

2340

client_class = functools.partial(ClientDBusTransitional,

2341

bus = bus)

2550

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

2342

2551

2343

2552

client_settings = Client.config_parser(client_config)

2344

2553

old_client_settings = {}

2345

2554

clients_data = {}

2346

2555

2556

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

2557

global wnull

2558

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

2559

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

2560

# mode

2561

if debug or not foreground:

2562

wnull.close()

2563

2347

2564

# Get client data and settings from last running state.

2348

2565

if server_settings["restore"]:

2349

2566

try:

2365

2582

2366

2583

with PGPEngine() as pgp:

2367

2584

for client_name, client in clients_data.iteritems():

2585

# Skip removed clients

2586

if client_name not in client_settings:

2587

continue

2588

2368

2589

# Decide which value to use after restoring saved state.

2369

2590

# We have three different values: Old config file,

2370

2591

# new config file, and saved state.

2432

2653

# Create all client objects

2433

2654

for client_name, client in clients_data.iteritems():

2434

2655

tcp_server.clients[client_name] = client_class(

2435

name = client_name, settings = client)

2656

name = client_name, settings = client,

2657

server_settings = server_settings)

2436

2658

2437

2659

if not tcp_server.clients:

2438

2660

logger.warning("No clients defined")

2439

2661

2440

if not debug:

2441

try:

2442

with pidfile:

2443

pid = os.getpid()

2444

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

2445

del pidfile

2446

except IOError:

2447

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

2448

pidfilename, pid)

2449

except NameError:

2450

# "pidfile" was never created

2451

pass

2662

if not foreground:

2663

if pidfile is not None:

2664

try:

2665

with pidfile:

2666

pid = os.getpid()

2667

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

2668

except IOError:

2669

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

2670

pidfilename, pid)

2671

del pidfile

2452

2672

del pidfilename

2453

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

2454

2673

2455

2674

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

2456

2675

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

2457

2676

2458

2677

if use_dbus:

2678

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

2679

"se.bsnet.fukt.Mandos"})

2459

2680

class MandosDBusService(DBusObjectWithProperties):

2460

2681

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

2461

2682

def __init__(self):

2515

2736

2516

2737

del _interface

2517

2738

2518

class MandosDBusServiceTransitional(MandosDBusService):

2519

__metaclass__ = AlternateDBusNamesMetaclass

2520

mandos_dbus_service = MandosDBusServiceTransitional()

2739

mandos_dbus_service = MandosDBusService()

2521

2740

2522

2741

def cleanup():

2523

2742

"Cleanup function; run on exit"

2524

2743

service.cleanup()

2525

2744

2526

2745

multiprocessing.active_children()

2746

wnull.close()

2527

2747

if not (tcp_server.clients or client_settings):

2528

2748

return

2529

2749

2541

2761

# A list of attributes that can not be pickled

2542

2762

# + secret.

2543

2763

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

2544

"checker"))

2764

"checker", "server_settings"))

2545

2765

for name, typ in (inspect.getmembers

2546

2766

(dbus.service.Object)):

2547

2767

exclude.add(name)

2556

2776

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

2557

2777

2558

2778

try:

2559

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

2560

prefix="clients-",

2561

dir=os.path.dirname

2562

(stored_state_path))

2563

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

2779

with (tempfile.NamedTemporaryFile

2780

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

2781

dir=os.path.dirname(stored_state_path),

2782

delete=False)) as stored_state:

2564

2783

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

2784

tempname=stored_state.name

2565

2785

os.rename(tempname, stored_state_path)

2566

2786

except (IOError, OSError) as e:

2567

2787

if not debug:

2575

2795

else:

2576

2796

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

2577

2797

exc_info=e)

2578

raise e

2798

raise

2579

2799

2580

2800

# Delete all clients, and settings from config

2581

2801

while tcp_server.clients: