/mandos/trunk : revision 726

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

68

import binascii

69

import tempfile

70

import itertools

71

import collections

71

72

73

import dbus

73

74

import dbus.service

78

79

import ctypes.util

79

80

import xml.dom.minidom

80

81

import inspect

81

import GnuPGInterface

82

83

try:

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

88

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.5.4"

91

version = "1.6.7"

92

stored_state_file = "clients.pickle"

93

94

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

95

syslogger = None

98

96

99

97

try:

100

98

if_nametoindex = (ctypes.cdll.LoadLibrary

116

114

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

117

115

"""init logger and add loglevel"""

118

116

117

global syslogger

118

syslogger = (logging.handlers.SysLogHandler

119

(facility =

120

logging.handlers.SysLogHandler.LOG_DAEMON,

121

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

119

122

syslogger.setFormatter(logging.Formatter

120

123

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

121

124

' %(message)s'))

139

142

class PGPEngine(object):

140

143

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

141

144

def __init__(self):

142

self.gnupg = GnuPGInterface.GnuPG()

143

145

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

144

self.gnupg = GnuPGInterface.GnuPG()

145

self.gnupg.options.meta_interactive = False

146

self.gnupg.options.homedir = self.tempdir

147

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

148

'--quiet',

149

'--no-use-agent'])

146

self.gnupgargs = ['--batch',

147

'--home', self.tempdir,

148

'--force-mdc',

149

'--quiet',

150

'--no-use-agent']

150

151

152

def __enter__(self):

152

153

return self

174

175

def password_encode(self, password):

175

176

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

176

177

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

177

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

178

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

179

if len(encoded) > 2048:

180

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

181

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

182

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

183

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

184

return encoded

178

185

179

186

def encrypt(self, data, password):

180

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

181

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

182

try:

183

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

184

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

185

attach_fhs={'stderr': devnull})

186

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

187

f.write(data)

188

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

189

ciphertext = f.read()

190

proc.wait()

191

except IOError as e:

192

raise PGPError(e)

193

self.gnupg.passphrase = None

187

passphrase = self.password_encode(password)

188

with tempfile.NamedTemporaryFile(dir=self.tempdir

189

) as passfile:

190

passfile.write(passphrase)

191

passfile.flush()

192

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

193

'--passphrase-file',

194

passfile.name]

195

+ self.gnupgargs,

196

stdin = subprocess.PIPE,

197

stdout = subprocess.PIPE,

198

stderr = subprocess.PIPE)

199

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

200

if proc.returncode != 0:

201

raise PGPError(err)

194

202

return ciphertext

195

203

196

204

def decrypt(self, data, password):

197

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

198

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

199

try:

200

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

201

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

202

attach_fhs={'stderr': devnull})

203

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

204

f.write(data)

205

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

206

decrypted_plaintext = f.read()

207

proc.wait()

208

except IOError as e:

209

raise PGPError(e)

210

self.gnupg.passphrase = None

205

passphrase = self.password_encode(password)

206

with tempfile.NamedTemporaryFile(dir = self.tempdir

207

) as passfile:

208

passfile.write(passphrase)

209

passfile.flush()

210

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

211

'--passphrase-file',

212

passfile.name]

213

+ self.gnupgargs,

214

stdin = subprocess.PIPE,

215

stdout = subprocess.PIPE,

216

stderr = subprocess.PIPE)

217

decrypted_plaintext, err = proc.communicate(input

218

= data)

219

if proc.returncode != 0:

220

raise PGPError(err)

211

221

return decrypted_plaintext

212

222

213

223

233

243

Used to optionally bind to the specified interface.

234

244

name: string; Example: 'Mandos'

235

245

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

236

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

246

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

237

247

port: integer; what port to announce

238

248

TXT: list of strings; TXT record for the service

239

249

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

328

338

elif state == avahi.ENTRY_GROUP_FAILURE:

329

339

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

330

340

unicode(error))

331

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

341

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

332

342

.format(error))

333

343

334

344

def cleanup(self):

385

395

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

386

396

ret = AvahiService.rename(self)

387

397

syslogger.setFormatter(logging.Formatter

388

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

398

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

389

399

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

390

400

.format(self.name)))

391

401

return ret

392

402

393

403

394

def timedelta_to_milliseconds(td):

395

"Convert a datetime.timedelta() to milliseconds"

396

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

397

+ (td.seconds * 1000)

398

+ (td.microseconds // 1000))

399

400

401

404

class Client(object):

402

405

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

403

406

439

442

runtime_expansions: Allowed attributes for runtime expansion.

440

443

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

441

444

disabled, or None

445

server_settings: The server_settings dict from main()

442

446

"""

443

447

444

448

runtime_expansions = ("approval_delay", "approval_duration",

446

450

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

447

451

"last_approval_request", "last_checked_ok",

448

452

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

449

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

450

"extended_timeout": "15m",

451

"interval": "2m",

453

client_defaults = { "timeout": "PT5M",

454

"extended_timeout": "PT15M",

455

"interval": "PT2M",

452

456

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

453

457

"host": "",

454

"approval_delay": "0s",

455

"approval_duration": "1s",

458

"approval_delay": "PT0S",

459

"approval_duration": "PT1S",

456

460

"approved_by_default": "True",

457

461

"enabled": "True",

458

462

}

459

463

460

def timeout_milliseconds(self):

461

"Return the 'timeout' attribute in milliseconds"

462

return timedelta_to_milliseconds(self.timeout)

463

464

def extended_timeout_milliseconds(self):

465

"Return the 'extended_timeout' attribute in milliseconds"

466

return timedelta_to_milliseconds(self.extended_timeout)

467

468

def interval_milliseconds(self):

469

"Return the 'interval' attribute in milliseconds"

470

return timedelta_to_milliseconds(self.interval)

471

472

def approval_delay_milliseconds(self):

473

return timedelta_to_milliseconds(self.approval_delay)

474

475

464

@staticmethod

476

465

def config_parser(config):

477

466

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

502

491

"rb") as secfile:

503

492

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

504

493

else:

505

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

494

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

506

495

.format(section))

507

496

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

508

497

client["extended_timeout"] = string_to_delta(

519

508

520

509

return settings

521

510

522

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

511

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

523

512

self.name = name

513

if server_settings is None:

514

server_settings = {}

515

self.server_settings = server_settings

524

516

# adding all client settings

525

for setting, value in settings.iteritems():

517

for setting, value in settings.items():

526

518

setattr(self, setting, value)

527

519

528

520

if self.enabled:

611

603

if self.checker_initiator_tag is not None:

612

604

gobject.source_remove(self.checker_initiator_tag)

613

605

self.checker_initiator_tag = (gobject.timeout_add

614

(self.interval_milliseconds(),

606

(int(self.interval

607

.total_seconds() * 1000),

615

608

self.start_checker))

616

609

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

617

610

if self.disable_initiator_tag is not None:

618

611

gobject.source_remove(self.disable_initiator_tag)

619

612

self.disable_initiator_tag = (gobject.timeout_add

620

(self.timeout_milliseconds(),

621

self.disable))

613

(int(self.timeout

614

.total_seconds() * 1000),

615

self.disable))

622

616

# Also start a new checker *right now*.

623

617

self.start_checker()

624

618

655

649

self.disable_initiator_tag = None

656

650

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

657

651

self.disable_initiator_tag = (gobject.timeout_add

658

(timedelta_to_milliseconds

659

(timeout), self.disable))

652

(int(timeout.total_seconds()

653

* 1000), self.disable))

660

654

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

661

655

662

656

def need_approval(self):

679

673

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

680

674

try:

681

675

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

682

except (AttributeError, OSError) as error:

683

if (isinstance(error, OSError)

684

and error.errno != errno.ECHILD):

685

raise error

676

except AttributeError:

677

pass

678

except OSError as error:

679

if error.errno != errno.ECHILD:

680

raise

686

681

else:

687

682

if pid:

688

683

logger.warning("Checker was a zombie")

692

687

# Start a new checker if needed

693

688

if self.checker is None:

694

689

# Escape attributes for the shell

695

escaped_attrs = dict(

696

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

697

for attr in

698

self.runtime_expansions)

690

escaped_attrs = { attr:

691

re.escape(unicode(getattr(self,

692

attr)))

693

for attr in self.runtime_expansions }

699

694

try:

700

695

command = self.checker_command % escaped_attrs

701

696

except TypeError as error:

710

705

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

711

706

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

712

707

# always replaced by /dev/null.)

708

# The exception is when not debugging but nevertheless

709

# running in the foreground; use the previously

710

# created wnull.

711

popen_args = {}

712

if (not self.server_settings["debug"]

713

and self.server_settings["foreground"]):

714

popen_args.update({"stdout": wnull,

715

"stderr": wnull })

713

716

self.checker = subprocess.Popen(command,

714

717

close_fds=True,

715

shell=True, cwd="/")

718

shell=True, cwd="/",

719

**popen_args)

716

720

except OSError as error:

717

721

logger.error("Failed to start subprocess",

718

722

exc_info=error)

723

return True

719

724

self.checker_callback_tag = (gobject.child_watch_add

720

725

(self.checker.pid,

721

726

self.checker_callback,

722

727

data=command))

723

728

# The checker may have completed before the gobject

724

729

# watch was added. Check for this.

725

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

730

try:

731

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

732

except OSError as error:

733

if error.errno == errno.ECHILD:

734

# This should never happen

735

logger.error("Child process vanished",

736

exc_info=error)

737

return True

738

raise

726

739

if pid:

727

740

gobject.source_remove(self.checker_callback_tag)

728

741

self.checker_callback(pid, status, command)

764

777

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

765

778

if byte_arrays and signature != "ay":

766

779

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

767

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

780

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

768

781

def decorator(func):

769

782

func._dbus_is_property = True

770

783

func._dbus_interface = dbus_interface

849

862

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

850

863

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

851

864

"""

852

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

865

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

853

866

False)

854

867

855

868

def _get_all_dbus_things(self, thing):

904

917

# The byte_arrays option is not supported yet on

905

918

# signatures other than "ay".

906

919

if prop._dbus_signature != "ay":

907

raise ValueError

920

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

921

"'ay' signature {!r}"

922

.format(prop._dbus_signature))

908

923

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

909

924

for byte in value))

910

925

prop(value)

974

989

(prop,

975

990

"_dbus_annotations",

976

991

{}))

977

for name, value in annots.iteritems():

992

for name, value in annots.items():

978

993

ann_tag = document.createElement(

979

994

"annotation")

980

995

ann_tag.setAttribute("name", name)

983

998

# Add interface annotation tags

984

999

for annotation, value in dict(

985

1000

itertools.chain.from_iterable(

986

annotations().iteritems()

1001

annotations().items()

987

1002

for name, annotations in

988

1003

self._get_all_dbus_things("interface")

989

1004

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

990

)).iteritems():

1005

)).items():

991

1006

ann_tag = document.createElement("annotation")

992

1007

ann_tag.setAttribute("name", annotation)

993

1008

ann_tag.setAttribute("value", value)

1049

1064

"""

1050

1065

def wrapper(cls):

1051

1066

for orig_interface_name, alt_interface_name in (

1052

alt_interface_names.iteritems()):

1067

alt_interface_names.items()):

1053

1068

attr = {}

1054

1069

interface_names = set()

1055

1070

# Go though all attributes of the class

1068

1083

interface_names.add(alt_interface)

1069

1084

# Is this a D-Bus signal?

1070

1085

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

1071

# Extract the original non-method function by

1072

# black magic

1086

# Extract the original non-method undecorated

1087

# function by black magic

1073

1088

nonmethod_func = (dict(

1074

1089

zip(attribute.func_code.co_freevars,

1075

1090

attribute.__closure__))["func"]

1172

1187

attribute.func_closure)))

1173

1188

if deprecate:

1174

1189

# Deprecate all alternate interfaces

1175

iname="_AlternateDBusNames_interface_annotation{0}"

1190

iname="_AlternateDBusNames_interface_annotation{}"

1176

1191

for interface_name in interface_names:

1177

1192

@dbus_interface_annotations(interface_name)

1178

1193

def func(self):

1187

1202

if interface_names:

1188

1203

# Replace the class with a new subclass of it with

1189

1204

# methods, signals, etc. as created above.

1190

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

1205

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

1191

1206

(cls,), attr)

1192

1207

return cls

1193

1208

return wrapper

1234

1249

to the D-Bus. Default: no transform

1235

1250

variant_level: D-Bus variant level. Default: 1

1236

1251

"""

1237

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

1252

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

1238

1253

def setter(self, value):

1239

1254

if hasattr(self, "dbus_object_path"):

1240

1255

if (not hasattr(self, attrname) or

1270

1285

approval_delay = notifychangeproperty(dbus.UInt64,

1271

1286

"ApprovalDelay",

1272

1287

type_func =

1273

timedelta_to_milliseconds)

1288

lambda td: td.total_seconds()

1289

* 1000)

1274

1290

approval_duration = notifychangeproperty(

1275

1291

dbus.UInt64, "ApprovalDuration",

1276

type_func = timedelta_to_milliseconds)

1292

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

1277

1293

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

1278

1294

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

1279

type_func =

1280

timedelta_to_milliseconds)

1295

type_func = lambda td:

1296

td.total_seconds() * 1000)

1281

1297

extended_timeout = notifychangeproperty(

1282

1298

dbus.UInt64, "ExtendedTimeout",

1283

type_func = timedelta_to_milliseconds)

1299

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

1284

1300

interval = notifychangeproperty(dbus.UInt64,

1285

1301

"Interval",

1286

1302

type_func =

1287

timedelta_to_milliseconds)

1303

lambda td: td.total_seconds()

1304

* 1000)

1288

1305

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

1289

1306

1290

1307

del notifychangeproperty

1318

1335

*args, **kwargs)

1319

1336

1320

1337

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

1321

old_checker = self.checker

1322

if self.checker is not None:

1323

old_checker_pid = self.checker.pid

1324

else:

1325

old_checker_pid = None

1338

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

1326

1339

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

1327

1340

# Only if new checker process was started

1328

1341

if (self.checker is not None

1337

1350

1338

1351

def approve(self, value=True):

1339

1352

self.approved = value

1340

gobject.timeout_add(timedelta_to_milliseconds

1341

(self.approval_duration),

1342

self._reset_approved)

1353

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

1354

* 1000), self._reset_approved)

1343

1355

self.send_changedstate()

1344

1356

1345

1357

## D-Bus methods, signals & properties

1448

1460

access="readwrite")

1449

1461

def ApprovalDelay_dbus_property(self, value=None):

1450

1462

if value is None: # get

1451

return dbus.UInt64(self.approval_delay_milliseconds())

1463

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

1464

* 1000)

1452

1465

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

1453

1466

1454

1467

# ApprovalDuration - property

1456

1469

access="readwrite")

1457

1470

def ApprovalDuration_dbus_property(self, value=None):

1458

1471

if value is None: # get

1459

return dbus.UInt64(timedelta_to_milliseconds(

1460

self.approval_duration))

1472

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

1473

* 1000)

1461

1474

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

1462

1475

1463

1476

# Name - property

1529

1542

access="readwrite")

1530

1543

def Timeout_dbus_property(self, value=None):

1531

1544

if value is None: # get

1532

return dbus.UInt64(self.timeout_milliseconds())

1545

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

1533

1546

old_timeout = self.timeout

1534

1547

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

1535

1548

# Reschedule disabling

1546

1559

gobject.source_remove(self.disable_initiator_tag)

1547

1560

self.disable_initiator_tag = (

1548

1561

gobject.timeout_add(

1549

timedelta_to_milliseconds(self.expires - now),

1550

self.disable))

1562

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

1563

* 1000), self.disable))

1551

1564

1552

1565

# ExtendedTimeout - property

1553

1566

@dbus_service_property(_interface, signature="t",

1554

1567

access="readwrite")

1555

1568

def ExtendedTimeout_dbus_property(self, value=None):

1556

1569

if value is None: # get

1557

return dbus.UInt64(self.extended_timeout_milliseconds())

1570

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

1571

* 1000)

1558

1572

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

1559

1573

1560

1574

# Interval - property

1562

1576

access="readwrite")

1563

1577

def Interval_dbus_property(self, value=None):

1564

1578

if value is None: # get

1565

return dbus.UInt64(self.interval_milliseconds())

1579

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

1566

1580

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

1567

1581

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

1568

1582

return

1673

1687

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

1674

1688

try:

1675

1689

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

1676

raise RuntimeError

1690

raise RuntimeError(line)

1677

1691

except (ValueError, IndexError, RuntimeError) as error:

1678

1692

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

1679

1693

return

1728

1742

if self.server.use_dbus:

1729

1743

# Emit D-Bus signal

1730

1744

client.NeedApproval(

1731

client.approval_delay_milliseconds(),

1732

client.approved_by_default)

1745

client.approval_delay.total_seconds()

1746

* 1000, client.approved_by_default)

1733

1747

else:

1734

1748

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

1735

1749

client.name)

1741

1755

#wait until timeout or approved

1742

1756

time = datetime.datetime.now()

1743

1757

client.changedstate.acquire()

1744

client.changedstate.wait(

1745

float(timedelta_to_milliseconds(delay)

1746

/ 1000))

1758

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

1747

1759

client.changedstate.release()

1748

1760

time2 = datetime.datetime.now()

1749

1761

if (time2 - time) >= delay:

1886

1898

1887

1899

def add_pipe(self, parent_pipe, proc):

1888

1900

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

1889

raise NotImplementedError

1901

raise NotImplementedError()

1890

1902

1891

1903

1892

1904

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1899

1911

use_ipv6: Boolean; to use IPv6 or not

1900

1912

"""

1901

1913

def __init__(self, server_address, RequestHandlerClass,

1902

interface=None, use_ipv6=True):

1914

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

1915

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

1916

creating a new one with socket.socket().

1917

"""

1903

1918

self.interface = interface

1904

1919

if use_ipv6:

1905

1920

self.address_family = socket.AF_INET6

1921

if socketfd is not None:

1922

# Save the file descriptor

1923

self.socketfd = socketfd

1924

# Save the original socket.socket() function

1925

self.socket_socket = socket.socket

1926

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

1927

#

1928

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

1929

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

1930

# patching socket.socket.)

1931

#

1932

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

1933

@functools.wraps(socket.socket)

1934

def socket_wrapper(*args, **kwargs):

1935

# Restore original function so subsequent calls are

1936

# not affected.

1937

socket.socket = self.socket_socket

1938

del self.socket_socket

1939

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

1940

# saved file descriptor.

1941

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

1942

# Replace socket.socket() function with wrapper

1943

socket.socket = socket_wrapper

1944

# The socketserver.TCPServer.__init__ will call

1945

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

1946

# socket_wrapper(), if socketfd was set.

1906

1947

socketserver.TCPServer.__init__(self, server_address,

1907

1948

RequestHandlerClass)

1949

1908

1950

def server_bind(self):

1909

1951

"""This overrides the normal server_bind() function

1910

1952

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

1918

1960

try:

1919

1961

self.socket.setsockopt(socket.SOL_SOCKET,

1920

1962

SO_BINDTODEVICE,

1921

str(self.interface

1922

+ '\0'))

1963

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

1923

1964

except socket.error as error:

1924

1965

if error.errno == errno.EPERM:

1925

logger.error("No permission to"

1926

" bind to interface %s",

1927

self.interface)

1966

logger.error("No permission to bind to"

1967

" interface %s", self.interface)

1928

1968

elif error.errno == errno.ENOPROTOOPT:

1929

1969

logger.error("SO_BINDTODEVICE not available;"

1930

1970

" cannot bind to interface %s",

1931

1971

self.interface)

1932

1972

elif error.errno == errno.ENODEV:

1933

logger.error("Interface %s does not"

1934

" exist, cannot bind",

1935

self.interface)

1973

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

1974

" cannot bind", self.interface)

1936

1975

else:

1937

1976

raise

1938

1977

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

1941

1980

if self.address_family == socket.AF_INET6:

1942

1981

any_address = "::" # in6addr_any

1943

1982

else:

1944

any_address = socket.INADDR_ANY

1983

any_address = "0.0.0.0" # INADDR_ANY

1945

1984

self.server_address = (any_address,

1946

1985

self.server_address[1])

1947

1986

elif not self.server_address[1]:

1968

2007

"""

1969

2008

def __init__(self, server_address, RequestHandlerClass,

1970

2009

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

1971

gnutls_priority=None, use_dbus=True):

2010

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

1972

2011

self.enabled = False

1973

2012

self.clients = clients

1974

2013

if self.clients is None:

1978

2017

IPv6_TCPServer.__init__(self, server_address,

1979

2018

RequestHandlerClass,

1980

2019

interface = interface,

1981

use_ipv6 = use_ipv6)

2020

use_ipv6 = use_ipv6,

2021

socketfd = socketfd)

1982

2022

def server_activate(self):

1983

2023

if self.enabled:

1984

2024

return socketserver.TCPServer.server_activate(self)

2062

2102

return True

2063

2103

2064

2104

2105

def rfc3339_duration_to_delta(duration):

2106

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

2107

2108

>>> rfc3339_duration_to_delta("P7D")

2109

datetime.timedelta(7)

2110

>>> rfc3339_duration_to_delta("PT60S")

2111

datetime.timedelta(0, 60)

2112

>>> rfc3339_duration_to_delta("PT60M")

2113

datetime.timedelta(0, 3600)

2114

>>> rfc3339_duration_to_delta("PT24H")

2115

datetime.timedelta(1)

2116

>>> rfc3339_duration_to_delta("P1W")

2117

datetime.timedelta(7)

2118

>>> rfc3339_duration_to_delta("PT5M30S")

2119

datetime.timedelta(0, 330)

2120

>>> rfc3339_duration_to_delta("P1DT3M20S")

2121

datetime.timedelta(1, 200)

2122

"""

2123

2124

# Parsing an RFC 3339 duration with regular expressions is not

2125

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

2126

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

2127

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

2128

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

2129

# avoid excessive use of external libraries.

2130

2131

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

2132

Token = collections.namedtuple("Token",

2133

("regexp", # To match token; if

2134

# "value" is not None,

2135

# must have a "group"

2136

# containing digits

2137

"value", # datetime.timedelta or

2138

# None

2139

"followers")) # Tokens valid after

2140

# this token

2141

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

2142

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

2143

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

2144

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

2145

datetime.timedelta(seconds=1),

2146

frozenset((token_end,)))

2147

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

2148

datetime.timedelta(minutes=1),

2149

frozenset((token_second, token_end)))

2150

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

2151

datetime.timedelta(hours=1),

2152

frozenset((token_minute, token_end)))

2153

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

2154

None,

2155

frozenset((token_hour, token_minute,

2156

token_second)))

2157

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

2158

datetime.timedelta(days=1),

2159

frozenset((token_time, token_end)))

2160

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

2161

datetime.timedelta(weeks=4),

2162

frozenset((token_day, token_end)))

2163

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

2164

datetime.timedelta(weeks=52),

2165

frozenset((token_month, token_end)))

2166

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

2167

datetime.timedelta(weeks=1),

2168

frozenset((token_end,)))

2169

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

2170

frozenset((token_year, token_month,

2171

token_day, token_time,

2172

token_week)))

2173

# Define starting values

2174

value = datetime.timedelta() # Value so far

2175

found_token = None

2176

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

2177

s = duration # String left to parse

2178

# Loop until end token is found

2179

while found_token is not token_end:

2180

# Search for any currently valid tokens

2181

for token in followers:

2182

match = token.regexp.match(s)

2183

if match is not None:

2184

# Token found

2185

if token.value is not None:

2186

# Value found, parse digits

2187

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

2188

# Add to value so far

2189

value += factor * token.value

2190

# Strip token from string

2191

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

2192

# Go to found token

2193

found_token = token

2194

# Set valid next tokens

2195

followers = found_token.followers

2196

break

2197

else:

2198

# No currently valid tokens were found

2199

raise ValueError("Invalid RFC 3339 duration")

2200

# End token found

2201

return value

2202

2203

2065

2204

def string_to_delta(interval):

2066

2205

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

2067

2206

2078

2217

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

2079

2218

datetime.timedelta(0, 330)

2080

2219

"""

2220

2221

try:

2222

return rfc3339_duration_to_delta(interval)

2223

except ValueError:

2224

pass

2225

2081

2226

timevalue = datetime.timedelta(0)

2082

2227

for s in interval.split():

2083

2228

try:

2094

2239

elif suffix == "w":

2095

2240

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

2096

2241

else:

2097

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

2242

raise ValueError("Unknown suffix {!r}"

2098

2243

.format(suffix))

2099

except (ValueError, IndexError) as e:

2244

except IndexError as e:

2100

2245

raise ValueError(*(e.args))

2101

2246

timevalue += delta

2102

2247

return timevalue

2117

2262

# Close all standard open file descriptors

2118

2263

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

2119

2264

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

2120

raise OSError(errno.ENODEV,

2121

"{0} not a character device"

2265

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

2122

2266

.format(os.devnull))

2123

2267

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

2124

2268

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

2134

2278

2135

2279

parser = argparse.ArgumentParser()

2136

2280

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

2137

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

2281

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

2138

2282

help="show version number and exit")

2139

2283

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

2140

2284

help="Bind to interface IF")

2146

2290

help="Run self-test")

2147

2291

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

2148

2292

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

2149

" to terminal")

2293

" to terminal", default=None)

2150

2294

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

2151

2295

help="Debug level for stdout output")

2152

2296

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

2159

2303

" files")

2160

2304

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

2161

2305

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

2162

" system bus interface")

2306

" system bus interface", default=None)

2163

2307

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

2164

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

2308

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

2309

default=None)

2165

2310

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

2166

2311

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

2167

" state")

2312

" state", default=None)

2313

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

2314

help="Specify a file descriptor to a network"

2315

" socket to use instead of creating one")

2168

2316

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

2169

2317

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

2318

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

2319

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

2320

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

2321

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

2322

default=None)

2170

2323

2171

2324

options = parser.parse_args()

2172

2325

2173

2326

if options.check:

2174

2327

import doctest

2175

doctest.testmod()

2176

sys.exit()

2328

fail_count, test_count = doctest.testmod()

2329

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

2177

2330

2178

2331

# Default values for config file for server-global settings

2179

2332

server_defaults = { "interface": "",

2181

2334

"port": "",

2182

2335

"debug": "False",

2183

2336

"priority":

2184

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

2337

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

2185

2338

"servicename": "Mandos",

2186

2339

"use_dbus": "True",

2187

2340

"use_ipv6": "True",

2188

2341

"debuglevel": "",

2189

2342

"restore": "True",

2190

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

2343

"socket": "",

2344

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

2345

"foreground": "False",

2346

"zeroconf": "True",

2191

2347

}

2192

2348

2193

2349

# Parse config file for server-global settings

2198

2354

# Convert the SafeConfigParser object to a dict

2199

2355

server_settings = server_config.defaults()

2200

2356

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

2201

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

2357

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

2202

2358

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

2203

2359

option)

2204

2360

if server_settings["port"]:

2205

2361

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

2206

2362

"port")

2363

if server_settings["socket"]:

2364

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

2365

"socket")

2366

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

2367

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

2368

# happen with a supplied network socket.

2369

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

2370

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

2371

["socket"])

2207

2372

del server_config

2208

2373

2209

2374

# Override the settings from the config file with command line

2211

2376

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

2212

2377

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

2213

2378

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

2214

"statedir"):

2379

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

2215

2380

value = getattr(options, option)

2216

2381

if value is not None:

2217

2382

server_settings[option] = value

2220

2385

for option in server_settings.keys():

2221

2386

if type(server_settings[option]) is str:

2222

2387

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

2388

# Force all boolean options to be boolean

2389

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

2390

"foreground", "zeroconf"):

2391

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

2392

# Debug implies foreground

2393

if server_settings["debug"]:

2394

server_settings["foreground"] = True

2223

2395

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

2224

2396

2225

2397

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

2226

2398

2399

if (not server_settings["zeroconf"] and

2400

not (server_settings["port"]

2401

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

2402

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

2403

" Zeroconf")

2404

2227

2405

# For convenience

2228

2406

debug = server_settings["debug"]

2229

2407

debuglevel = server_settings["debuglevel"]

2231

2409

use_ipv6 = server_settings["use_ipv6"]

2232

2410

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

2233

2411

stored_state_file)

2412

foreground = server_settings["foreground"]

2413

zeroconf = server_settings["zeroconf"]

2234

2414

2235

2415

if debug:

2236

2416

initlogger(debug, logging.DEBUG)

2243

2423

2244

2424

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

2245

2425

syslogger.setFormatter(logging.Formatter

2246

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

2426

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

2247

2427

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

2248

2428

.format(server_settings

2249

2429

["servicename"])))

2257

2437

global mandos_dbus_service

2258

2438

mandos_dbus_service = None

2259

2439

2440

socketfd = None

2441

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

2442

socketfd = server_settings["socket"]

2260

2443

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

2261

2444

server_settings["port"]),

2262

2445

ClientHandler,

2265

2448

use_ipv6=use_ipv6,

2266

2449

gnutls_priority=

2267

2450

server_settings["priority"],

2268

use_dbus=use_dbus)

2269

if not debug:

2270

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

2451

use_dbus=use_dbus,

2452

socketfd=socketfd)

2453

if not foreground:

2454

pidfilename = "/run/mandos.pid"

2455

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

2456

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

2457

pidfile = None

2271

2458

try:

2272

2459

pidfile = open(pidfilename, "w")

2273

2460

except IOError as e:

2289

2476

os.setuid(uid)

2290

2477

except OSError as error:

2291

2478

if error.errno != errno.EPERM:

2292

raise error

2479

raise

2293

2480

2294

2481

if debug:

2295

2482

# Enable all possible GnuTLS debugging

2312

2499

os.close(null)

2313

2500

2314

2501

# Need to fork before connecting to D-Bus

2315

if not debug:

2502

if not foreground:

2316

2503

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

2317

2504

daemon()

2318

2505

2506

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

2507

# need to inform gobject that threads will be used.

2319

2508

gobject.threads_init()

2320

2509

2321

2510

global main_loop

2336

2525

use_dbus = False

2337

2526

server_settings["use_dbus"] = False

2338

2527

tcp_server.use_dbus = False

2339

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2340

service = AvahiServiceToSyslog(name =

2341

server_settings["servicename"],

2342

servicetype = "_mandos._tcp",

2343

protocol = protocol, bus = bus)

2344

if server_settings["interface"]:

2345

service.interface = (if_nametoindex

2346

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

2528

if zeroconf:

2529

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2530

service = AvahiServiceToSyslog(name =

2531

server_settings["servicename"],

2532

servicetype = "_mandos._tcp",

2533

protocol = protocol, bus = bus)

2534

if server_settings["interface"]:

2535

service.interface = (if_nametoindex

2536

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

2347

2537

2348

2538

global multiprocessing_manager

2349

2539

multiprocessing_manager = multiprocessing.Manager()

2356

2546

old_client_settings = {}

2357

2547

clients_data = {}

2358

2548

2549

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

2550

global wnull

2551

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

2552

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

2553

# mode

2554

if debug or not foreground:

2555

wnull.close()

2556

2359

2557

# Get client data and settings from last running state.

2360

2558

if server_settings["restore"]:

2361

2559

try:

2365

2563

os.remove(stored_state_path)

2366

2564

except IOError as e:

2367

2565

if e.errno == errno.ENOENT:

2368

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

2566

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

2369

2567

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

2370

2568

else:

2371

2569

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

2376

2574

"EOFError:", exc_info=e)

2377

2575

2378

2576

with PGPEngine() as pgp:

2379

for client_name, client in clients_data.iteritems():

2577

for client_name, client in clients_data.items():

2578

# Skip removed clients

2579

if client_name not in client_settings:

2580

continue

2581

2380

2582

# Decide which value to use after restoring saved state.

2381

2583

# We have three different values: Old config file,

2382

2584

# new config file, and saved state.

2403

2605

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

2404

2606

if not client["last_checked_ok"]:

2405

2607

logger.warning(

2406

"disabling client {0} - Client never "

2608

"disabling client {} - Client never "

2407

2609

"performed a successful checker"

2408

2610

.format(client_name))

2409

2611

client["enabled"] = False

2410

2612

elif client["last_checker_status"] != 0:

2411

2613

logger.warning(

2412

"disabling client {0} - Client "

2413

"last checker failed with error code {1}"

2614

"disabling client {} - Client last"

2615

" checker failed with error code {}"

2414

2616

.format(client_name,

2415

2617

client["last_checker_status"]))

2416

2618

client["enabled"] = False

2419

2621

.utcnow()

2420

2622

+ client["timeout"])

2421

2623

logger.debug("Last checker succeeded,"

2422

" keeping {0} enabled"

2624

" keeping {} enabled"

2423

2625

.format(client_name))

2424

2626

try:

2425

2627

client["secret"] = (

2428

2630

["secret"]))

2429

2631

except PGPError:

2430

2632

# If decryption fails, we use secret from new settings

2431

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

2633

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

2432

2634

.format(client_name))

2433

2635

client["secret"] = (

2434

2636

client_settings[client_name]["secret"])

2442

2644

clients_data[client_name] = client_settings[client_name]

2443

2645

2444

2646

# Create all client objects

2445

for client_name, client in clients_data.iteritems():

2647

for client_name, client in clients_data.items():

2446

2648

tcp_server.clients[client_name] = client_class(

2447

name = client_name, settings = client)

2649

name = client_name, settings = client,

2650

server_settings = server_settings)

2448

2651

2449

2652

if not tcp_server.clients:

2450

2653

logger.warning("No clients defined")

2451

2654

2452

if not debug:

2453

try:

2454

with pidfile:

2455

pid = os.getpid()

2456

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

2457

del pidfile

2458

except IOError:

2459

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

2460

pidfilename, pid)

2461

except NameError:

2462

# "pidfile" was never created

2463

pass

2655

if not foreground:

2656

if pidfile is not None:

2657

try:

2658

with pidfile:

2659

pid = os.getpid()

2660

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

2661

except IOError:

2662

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

2663

pidfilename, pid)

2664

del pidfile

2464

2665

del pidfilename

2465

2666

2466

2667

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

2532

2733

2533

2734

def cleanup():

2534

2735

"Cleanup function; run on exit"

2535

service.cleanup()

2736

if zeroconf:

2737

service.cleanup()

2536

2738

2537

2739

multiprocessing.active_children()

2740

wnull.close()

2538

2741

if not (tcp_server.clients or client_settings):

2539

2742

return

2540

2743

2551

2754

2552

2755

# A list of attributes that can not be pickled

2553

2756

# + secret.

2554

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

2555

"checker"))

2757

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

2758

"checker", "server_settings" }

2556

2759

for name, typ in (inspect.getmembers

2557

2760

(dbus.service.Object)):

2558

2761

exclude.add(name)

2581

2784

except NameError:

2582

2785

pass

2583

2786

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

2584

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

2787

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

2585

2788

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

2586

2789

else:

2587

2790

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

2588

2791

exc_info=e)

2589

raise e

2792

raise

2590

2793

2591

2794

# Delete all clients, and settings from config

2592

2795

while tcp_server.clients:

2616

2819

tcp_server.server_activate()

2617

2820

2618

2821

# Find out what port we got

2619

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

2822

if zeroconf:

2823

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

2620

2824

if use_ipv6:

2621

2825

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

2622

2826

" flowinfo %d, scope_id %d",

2628

2832

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

2629

2833

2630

2834

try:

2631

# From the Avahi example code

2632

try:

2633

service.activate()

2634

except dbus.exceptions.DBusException as error:

2635

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

2636

cleanup()

2637

sys.exit(1)

2638

# End of Avahi example code

2835

if zeroconf:

2836

# From the Avahi example code

2837

try:

2838

service.activate()

2839

except dbus.exceptions.DBusException as error:

2840

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

2841

cleanup()

2842

sys.exit(1)

2843

# End of Avahi example code

2639

2844

2640

2845

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

2641

2846

lambda *args, **kwargs: