/mandos/release : revision 237.7.133

1

#!/usr/bin/python2.7

1

#!/usr/bin/python

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

72

71

73

72

import dbus

74

73

import dbus.service

79

78

import ctypes.util

80

79

import xml.dom.minidom

81

80

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

91

version = "1.5.3"

92

stored_state_file = "clients.pickle"

93

94

logger = logging.getLogger()

95

syslogger = None

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

96

98

97

99

try:

98

100

if_nametoindex = (ctypes.cdll.LoadLibrary

114

116

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

115

117

"""init logger and add loglevel"""

116

118

117

global syslogger

118

syslogger = (logging.handlers.SysLogHandler

119

(facility =

120

logging.handlers.SysLogHandler.LOG_DAEMON,

121

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

122

119

syslogger.setFormatter(logging.Formatter

123

120

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

124

121

' %(message)s'))

142

139

class PGPEngine(object):

143

140

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

144

141

def __init__(self):

142

self.gnupg = GnuPGInterface.GnuPG()

145

143

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

146

self.gnupgargs = ['--batch',

147

'--home', self.tempdir,

148

'--force-mdc',

149

'--quiet',

150

'--no-use-agent']

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

151

150

152

151

def __enter__(self):

153

152

return self

154

153

155

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

154

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

156

155

self._cleanup()

157

156

return False

158

157

175

174

def password_encode(self, password):

176

175

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

177

176

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

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

177

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

185

178

186

179

def encrypt(self, data, password):

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)

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

202

194

return ciphertext

203

195

204

196

def decrypt(self, data, password):

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)

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

221

211

return decrypted_plaintext

222

212

223

213

243

233

Used to optionally bind to the specified interface.

244

234

name: string; Example: 'Mandos'

245

235

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

246

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

236

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

247

237

port: integer; what port to announce

248

238

TXT: list of strings; TXT record for the service

249

239

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

338

328

elif state == avahi.ENTRY_GROUP_FAILURE:

339

329

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

340

330

unicode(error))

341

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

331

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

342

332

.format(error))

343

333

344

334

def cleanup(self):

395

385

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

396

386

ret = AvahiService.rename(self)

397

387

syslogger.setFormatter(logging.Formatter

398

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

388

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

399

389

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

400

390

.format(self.name)))

401

391

return ret

402

392

403

393

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

404

401

class Client(object):

405

402

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

406

403

442

439

runtime_expansions: Allowed attributes for runtime expansion.

443

440

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

444

441

disabled, or None

445

server_settings: The server_settings dict from main()

446

442

"""

447

443

448

444

runtime_expansions = ("approval_delay", "approval_duration",

450

446

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

451

447

"last_approval_request", "last_checked_ok",

452

448

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

453

client_defaults = { "timeout": "PT5M",

454

"extended_timeout": "PT15M",

455

"interval": "PT2M",

449

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

450

"extended_timeout": "15m",

451

"interval": "2m",

456

452

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

457

453

"host": "",

458

"approval_delay": "PT0S",

459

"approval_duration": "PT1S",

454

"approval_delay": "0s",

455

"approval_duration": "1s",

460

456

"approved_by_default": "True",

461

457

"enabled": "True",

462

458

}

463

459

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

464

475

@staticmethod

465

476

def config_parser(config):

466

477

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

491

502

"rb") as secfile:

492

503

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

493

504

else:

494

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

505

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

495

506

.format(section))

496

507

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

497

508

client["extended_timeout"] = string_to_delta(

508

519

509

520

return settings

510

521

511

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

522

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

512

523

self.name = name

513

if server_settings is None:

514

server_settings = {}

515

self.server_settings = server_settings

516

524

# adding all client settings

517

for setting, value in settings.items():

525

for setting, value in settings.iteritems():

518

526

setattr(self, setting, value)

519

527

520

528

if self.enabled:

603

611

if self.checker_initiator_tag is not None:

604

612

gobject.source_remove(self.checker_initiator_tag)

605

613

self.checker_initiator_tag = (gobject.timeout_add

606

(int(self.interval

607

.total_seconds() * 1000),

614

(self.interval_milliseconds(),

608

615

self.start_checker))

609

616

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

610

617

if self.disable_initiator_tag is not None:

611

618

gobject.source_remove(self.disable_initiator_tag)

612

619

self.disable_initiator_tag = (gobject.timeout_add

613

(int(self.timeout

614

.total_seconds() * 1000),

615

self.disable))

620

(self.timeout_milliseconds(),

621

self.disable))

616

622

# Also start a new checker *right now*.

617

623

self.start_checker()

618

624

649

655

self.disable_initiator_tag = None

650

656

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

651

657

self.disable_initiator_tag = (gobject.timeout_add

652

(int(timeout.total_seconds()

653

* 1000), self.disable))

658

(timedelta_to_milliseconds

659

(timeout), self.disable))

654

660

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

655

661

656

662

def need_approval(self):

673

679

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

674

680

try:

675

681

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

676

except AttributeError:

677

pass

678

except OSError as error:

679

if error.errno != errno.ECHILD:

680

raise

682

except (AttributeError, OSError) as error:

683

if (isinstance(error, OSError)

684

and error.errno != errno.ECHILD):

685

raise error

681

686

else:

682

687

if pid:

683

688

logger.warning("Checker was a zombie")

687

692

# Start a new checker if needed

688

693

if self.checker is None:

689

694

# Escape attributes for the shell

690

escaped_attrs = { attr:

691

re.escape(unicode(getattr(self,

692

attr)))

693

for attr in self.runtime_expansions }

695

escaped_attrs = dict(

696

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

697

for attr in

698

self.runtime_expansions)

694

699

try:

695

700

command = self.checker_command % escaped_attrs

696

701

except TypeError as error:

705

710

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

706

711

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

707

712

# 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 })

716

713

self.checker = subprocess.Popen(command,

717

714

close_fds=True,

718

shell=True, cwd="/",

719

**popen_args)

715

shell=True, cwd="/")

720

716

except OSError as error:

721

717

logger.error("Failed to start subprocess",

722

718

exc_info=error)

723

return True

724

719

self.checker_callback_tag = (gobject.child_watch_add

725

720

(self.checker.pid,

726

721

self.checker_callback,

727

722

data=command))

728

723

# The checker may have completed before the gobject

729

724

# watch was added. Check for this.

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

725

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

739

726

if pid:

740

727

gobject.source_remove(self.checker_callback_tag)

741

728

self.checker_callback(pid, status, command)

777

764

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

778

765

if byte_arrays and signature != "ay":

779

766

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

780

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

767

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

781

768

def decorator(func):

782

769

func._dbus_is_property = True

783

770

func._dbus_interface = dbus_interface

862

849

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

863

850

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

864

851

"""

865

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

852

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

866

853

False)

867

854

868

855

def _get_all_dbus_things(self, thing):

917

904

# The byte_arrays option is not supported yet on

918

905

# signatures other than "ay".

919

906

if prop._dbus_signature != "ay":

920

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

921

"'ay' signature {!r}"

922

.format(prop._dbus_signature))

907

raise ValueError

923

908

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

924

909

for byte in value))

925

910

prop(value)

989

974

(prop,

990

975

"_dbus_annotations",

991

976

{}))

992

for name, value in annots.items():

977

for name, value in annots.iteritems():

993

978

ann_tag = document.createElement(

994

979

"annotation")

995

980

ann_tag.setAttribute("name", name)

998

983

# Add interface annotation tags

999

984

for annotation, value in dict(

1000

985

itertools.chain.from_iterable(

1001

annotations().items()

986

annotations().iteritems()

1002

987

for name, annotations in

1003

988

self._get_all_dbus_things("interface")

1004

989

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

1005

)).items():

990

)).iteritems():

1006

991

ann_tag = document.createElement("annotation")

1007

992

ann_tag.setAttribute("name", annotation)

1008

993

ann_tag.setAttribute("value", value)

1031

1016

return xmlstring

1032

1017

1033

1018

1034

def datetime_to_dbus(dt, variant_level=0):

1019

def datetime_to_dbus (dt, variant_level=0):

1035

1020

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

1036

1021

if dt is None:

1037

1022

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

1045

1030

interface names according to the "alt_interface_names" mapping.

1046

1031

Usage:

1047

1032

1048

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

1049

"net.example.AlternateInterface"})

1033

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

1034

"net.example.AlternateInterface"})

1050

1035

class SampleDBusObject(dbus.service.Object):

1051

1036

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

1052

1037

def SampleDBusMethod():

1064

1049

"""

1065

1050

def wrapper(cls):

1066

1051

for orig_interface_name, alt_interface_name in (

1067

alt_interface_names.items()):

1052

alt_interface_names.iteritems()):

1068

1053

attr = {}

1069

1054

interface_names = set()

1070

1055

# Go though all attributes of the class

1083

1068

interface_names.add(alt_interface)

1084

1069

# Is this a D-Bus signal?

1085

1070

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

1086

# Extract the original non-method undecorated

1087

# function by black magic

1071

# Extract the original non-method function by

1072

# black magic

1088

1073

nonmethod_func = (dict(

1089

1074

zip(attribute.func_code.co_freevars,

1090

1075

attribute.__closure__))["func"]

1187

1172

attribute.func_closure)))

1188

1173

if deprecate:

1189

1174

# Deprecate all alternate interfaces

1190

iname="_AlternateDBusNames_interface_annotation{}"

1175

iname="_AlternateDBusNames_interface_annotation{0}"

1191

1176

for interface_name in interface_names:

1192

1177

@dbus_interface_annotations(interface_name)

1193

1178

def func(self):

1202

1187

if interface_names:

1203

1188

# Replace the class with a new subclass of it with

1204

1189

# methods, signals, etc. as created above.

1205

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

1190

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

1206

1191

(cls,), attr)

1207

1192

return cls

1208

1193

return wrapper

1249

1234

to the D-Bus. Default: no transform

1250

1235

variant_level: D-Bus variant level. Default: 1

1251

1236

"""

1252

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

1237

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

1253

1238

def setter(self, value):

1254

1239

if hasattr(self, "dbus_object_path"):

1255

1240

if (not hasattr(self, attrname) or

1285

1270

approval_delay = notifychangeproperty(dbus.UInt64,

1286

1271

"ApprovalDelay",

1287

1272

type_func =

1288

lambda td: td.total_seconds()

1289

* 1000)

1273

timedelta_to_milliseconds)

1290

1274

approval_duration = notifychangeproperty(

1291

1275

dbus.UInt64, "ApprovalDuration",

1292

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

1276

type_func = timedelta_to_milliseconds)

1293

1277

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

1294

1278

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

1295

type_func = lambda td:

1296

td.total_seconds() * 1000)

1279

type_func =

1280

timedelta_to_milliseconds)

1297

1281

extended_timeout = notifychangeproperty(

1298

1282

dbus.UInt64, "ExtendedTimeout",

1299

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

1283

type_func = timedelta_to_milliseconds)

1300

1284

interval = notifychangeproperty(dbus.UInt64,

1301

1285

"Interval",

1302

1286

type_func =

1303

lambda td: td.total_seconds()

1304

* 1000)

1287

timedelta_to_milliseconds)

1305

1288

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

1306

1289

1307

1290

del notifychangeproperty

1335

1318

*args, **kwargs)

1336

1319

1337

1320

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

1338

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

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

1339

1326

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

1340

1327

# Only if new checker process was started

1341

1328

if (self.checker is not None

1350

1337

1351

1338

def approve(self, value=True):

1352

1339

self.approved = value

1353

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

1354

* 1000), self._reset_approved)

1340

gobject.timeout_add(timedelta_to_milliseconds

1341

(self.approval_duration),

1342

self._reset_approved)

1355

1343

self.send_changedstate()

1356

1344

1357

1345

## D-Bus methods, signals & properties

1460

1448

access="readwrite")

1461

1449

def ApprovalDelay_dbus_property(self, value=None):

1462

1450

if value is None: # get

1463

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

1464

* 1000)

1451

return dbus.UInt64(self.approval_delay_milliseconds())

1465

1452

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

1466

1453

1467

1454

# ApprovalDuration - property

1469

1456

access="readwrite")

1470

1457

def ApprovalDuration_dbus_property(self, value=None):

1471

1458

if value is None: # get

1472

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

1473

* 1000)

1459

return dbus.UInt64(timedelta_to_milliseconds(

1460

self.approval_duration))

1474

1461

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

1475

1462

1476

1463

# Name - property

1542

1529

access="readwrite")

1543

1530

def Timeout_dbus_property(self, value=None):

1544

1531

if value is None: # get

1545

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

1532

return dbus.UInt64(self.timeout_milliseconds())

1546

1533

old_timeout = self.timeout

1547

1534

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

1548

1535

# Reschedule disabling

1559

1546

gobject.source_remove(self.disable_initiator_tag)

1560

1547

self.disable_initiator_tag = (

1561

1548

gobject.timeout_add(

1562

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

1563

* 1000), self.disable))

1549

timedelta_to_milliseconds(self.expires - now),

1550

self.disable))

1564

1551

1565

1552

# ExtendedTimeout - property

1566

1553

@dbus_service_property(_interface, signature="t",

1567

1554

access="readwrite")

1568

1555

def ExtendedTimeout_dbus_property(self, value=None):

1569

1556

if value is None: # get

1570

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

1571

* 1000)

1557

return dbus.UInt64(self.extended_timeout_milliseconds())

1572

1558

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

1573

1559

1574

1560

# Interval - property

1576

1562

access="readwrite")

1577

1563

def Interval_dbus_property(self, value=None):

1578

1564

if value is None: # get

1579

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

1565

return dbus.UInt64(self.interval_milliseconds())

1580

1566

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

1581

1567

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

1582

1568

return

1687

1673

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

1688

1674

try:

1689

1675

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

1690

raise RuntimeError(line)

1676

raise RuntimeError

1691

1677

except (ValueError, IndexError, RuntimeError) as error:

1692

1678

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

1693

1679

return

1742

1728

if self.server.use_dbus:

1743

1729

# Emit D-Bus signal

1744

1730

client.NeedApproval(

1745

client.approval_delay.total_seconds()

1746

* 1000, client.approved_by_default)

1731

client.approval_delay_milliseconds(),

1732

client.approved_by_default)

1747

1733

else:

1748

1734

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

1749

1735

client.name)

1755

1741

#wait until timeout or approved

1756

1742

time = datetime.datetime.now()

1757

1743

client.changedstate.acquire()

1758

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

1744

client.changedstate.wait(

1745

float(timedelta_to_milliseconds(delay)

1746

/ 1000))

1759

1747

client.changedstate.release()

1760

1748

time2 = datetime.datetime.now()

1761

1749

if (time2 - time) >= delay:

1898

1886

1899

1887

def add_pipe(self, parent_pipe, proc):

1900

1888

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

1901

raise NotImplementedError()

1889

raise NotImplementedError

1902

1890

1903

1891

1904

1892

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1911

1899

use_ipv6: Boolean; to use IPv6 or not

1912

1900

"""

1913

1901

def __init__(self, server_address, RequestHandlerClass,

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

"""

1902

interface=None, use_ipv6=True):

1918

1903

self.interface = interface

1919

1904

if use_ipv6:

1920

1905

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.

1947

1906

socketserver.TCPServer.__init__(self, server_address,

1948

1907

RequestHandlerClass)

1949

1950

1908

def server_bind(self):

1951

1909

"""This overrides the normal server_bind() function

1952

1910

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

1960

1918

try:

1961

1919

self.socket.setsockopt(socket.SOL_SOCKET,

1962

1920

SO_BINDTODEVICE,

1963

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

1921

str(self.interface

1922

+ '\0'))

1964

1923

except socket.error as error:

1965

1924

if error.errno == errno.EPERM:

1966

logger.error("No permission to bind to"

1967

" interface %s", self.interface)

1925

logger.error("No permission to"

1926

" bind to interface %s",

1927

self.interface)

1968

1928

elif error.errno == errno.ENOPROTOOPT:

1969

1929

logger.error("SO_BINDTODEVICE not available;"

1970

1930

" cannot bind to interface %s",

1971

1931

self.interface)

1972

1932

elif error.errno == errno.ENODEV:

1973

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

1974

" cannot bind", self.interface)

1933

logger.error("Interface %s does not"

1934

" exist, cannot bind",

1935

self.interface)

1975

1936

else:

1976

1937

raise

1977

1938

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

1980

1941

if self.address_family == socket.AF_INET6:

1981

1942

any_address = "::" # in6addr_any

1982

1943

else:

1983

any_address = "0.0.0.0" # INADDR_ANY

1944

any_address = socket.INADDR_ANY

1984

1945

self.server_address = (any_address,

1985

1946

self.server_address[1])

1986

1947

elif not self.server_address[1]:

2007

1968

"""

2008

1969

def __init__(self, server_address, RequestHandlerClass,

2009

1970

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

2010

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

1971

gnutls_priority=None, use_dbus=True):

2011

1972

self.enabled = False

2012

1973

self.clients = clients

2013

1974

if self.clients is None:

2017

1978

IPv6_TCPServer.__init__(self, server_address,

2018

1979

RequestHandlerClass,

2019

1980

interface = interface,

2020

use_ipv6 = use_ipv6,

2021

socketfd = socketfd)

1981

use_ipv6 = use_ipv6)

2022

1982

def server_activate(self):

2023

1983

if self.enabled:

2024

1984

return socketserver.TCPServer.server_activate(self)

2102

2062

return True

2103

2063

2104

2064

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

2204

2065

def string_to_delta(interval):

2205

2066

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

2206

2067

2217

2078

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

2218

2079

datetime.timedelta(0, 330)

2219

2080

"""

2220

2221

try:

2222

return rfc3339_duration_to_delta(interval)

2223

except ValueError:

2224

pass

2225

2226

2081

timevalue = datetime.timedelta(0)

2227

2082

for s in interval.split():

2228

2083

try:

2239

2094

elif suffix == "w":

2240

2095

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

2241

2096

else:

2242

raise ValueError("Unknown suffix {!r}"

2097

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

2243

2098

.format(suffix))

2244

except IndexError as e:

2099

except (ValueError, IndexError) as e:

2245

2100

raise ValueError(*(e.args))

2246

2101

timevalue += delta

2247

2102

return timevalue

2262

2117

# Close all standard open file descriptors

2263

2118

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

2264

2119

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

2265

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

2120

raise OSError(errno.ENODEV,

2121

"{0} not a character device"

2266

2122

.format(os.devnull))

2267

2123

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

2268

2124

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

2278

2134

2279

2135

parser = argparse.ArgumentParser()

2280

2136

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

2281

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

2137

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

2282

2138

help="show version number and exit")

2283

2139

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

2284

2140

help="Bind to interface IF")

2290

2146

help="Run self-test")

2291

2147

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

2292

2148

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

2293

" to terminal", default=None)

2149

" to terminal")

2294

2150

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

2295

2151

help="Debug level for stdout output")

2296

2152

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

2303

2159

" files")

2304

2160

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

2305

2161

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

2306

" system bus interface", default=None)

2162

" system bus interface")

2307

2163

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

2308

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

2309

default=None)

2164

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

2310

2165

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

2311

2166

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

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")

2167

" state")

2316

2168

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

2317

2169

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)

2323

2170

2324

2171

options = parser.parse_args()

2325

2172

2326

2173

if options.check:

2327

2174

import doctest

2328

fail_count, test_count = doctest.testmod()

2329

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

2175

doctest.testmod()

2176

sys.exit()

2330

2177

2331

2178

# Default values for config file for server-global settings

2332

2179

server_defaults = { "interface": "",

2334

2181

"port": "",

2335

2182

"debug": "False",

2336

2183

"priority":

2337

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

2184

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

2338

2185

"servicename": "Mandos",

2339

2186

"use_dbus": "True",

2340

2187

"use_ipv6": "True",

2341

2188

"debuglevel": "",

2342

2189

"restore": "True",

2343

"socket": "",

2344

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

2345

"foreground": "False",

2346

"zeroconf": "True",

2190

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

2347

2191

}

2348

2192

2349

2193

# Parse config file for server-global settings

2354

2198

# Convert the SafeConfigParser object to a dict

2355

2199

server_settings = server_config.defaults()

2356

2200

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

2357

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

2201

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

2358

2202

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

2359

2203

option)

2360

2204

if server_settings["port"]:

2361

2205

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

2362

2206

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

2372

2207

del server_config

2373

2208

2374

2209

# Override the settings from the config file with command line

2376

2211

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

2377

2212

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

2378

2213

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

2379

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

2214

"statedir"):

2380

2215

value = getattr(options, option)

2381

2216

if value is not None:

2382

2217

server_settings[option] = value

2385

2220

for option in server_settings.keys():

2386

2221

if type(server_settings[option]) is str:

2387

2222

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

2395

2223

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

2396

2224

2397

2225

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

2398

2226

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

2405

2227

# For convenience

2406

2228

debug = server_settings["debug"]

2407

2229

debuglevel = server_settings["debuglevel"]

2409

2231

use_ipv6 = server_settings["use_ipv6"]

2410

2232

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

2411

2233

stored_state_file)

2412

foreground = server_settings["foreground"]

2413

zeroconf = server_settings["zeroconf"]

2414

2234

2415

2235

if debug:

2416

2236

initlogger(debug, logging.DEBUG)

2423

2243

2424

2244

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

2425

2245

syslogger.setFormatter(logging.Formatter

2426

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

2246

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

2427

2247

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

2428

2248

.format(server_settings

2429

2249

["servicename"])))

2437

2257

global mandos_dbus_service

2438

2258

mandos_dbus_service = None

2439

2259

2440

socketfd = None

2441

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

2442

socketfd = server_settings["socket"]

2443

2260

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

2444

2261

server_settings["port"]),

2445

2262

ClientHandler,

2448

2265

use_ipv6=use_ipv6,

2449

2266

gnutls_priority=

2450

2267

server_settings["priority"],

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

2268

use_dbus=use_dbus)

2269

if not debug:

2270

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

2458

2271

try:

2459

2272

pidfile = open(pidfilename, "w")

2460

2273

except IOError as e:

2476

2289

os.setuid(uid)

2477

2290

except OSError as error:

2478

2291

if error.errno != errno.EPERM:

2479

raise

2292

raise error

2480

2293

2481

2294

if debug:

2482

2295

# Enable all possible GnuTLS debugging

2499

2312

os.close(null)

2500

2313

2501

2314

# Need to fork before connecting to D-Bus

2502

if not foreground:

2315

if not debug:

2503

2316

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

2504

2317

daemon()

2505

2318

2506

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

2507

# need to inform gobject that threads will be used.

2508

2319

gobject.threads_init()

2509

2320

2510

2321

global main_loop

2525

2336

use_dbus = False

2526

2337

server_settings["use_dbus"] = False

2527

2338

tcp_server.use_dbus = False

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

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

2537

2347

2538

2348

global multiprocessing_manager

2539

2349

multiprocessing_manager = multiprocessing.Manager()

2546

2356

old_client_settings = {}

2547

2357

clients_data = {}

2548

2358

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

2557

2359

# Get client data and settings from last running state.

2558

2360

if server_settings["restore"]:

2559

2361

try:

2563

2365

os.remove(stored_state_path)

2564

2366

except IOError as e:

2565

2367

if e.errno == errno.ENOENT:

2566

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

2368

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

2567

2369

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

2568

2370

else:

2569

2371

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

2574

2376

"EOFError:", exc_info=e)

2575

2377

2576

2378

with PGPEngine() as pgp:

2577

for client_name, client in clients_data.items():

2578

# Skip removed clients

2579

if client_name not in client_settings:

2580

continue

2581

2379

for client_name, client in clients_data.iteritems():

2582

2380

# Decide which value to use after restoring saved state.

2583

2381

# We have three different values: Old config file,

2584

2382

# new config file, and saved state.

2605

2403

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

2606

2404

if not client["last_checked_ok"]:

2607

2405

logger.warning(

2608

"disabling client {} - Client never "

2406

"disabling client {0} - Client never "

2609

2407

"performed a successful checker"

2610

2408

.format(client_name))

2611

2409

client["enabled"] = False

2612

2410

elif client["last_checker_status"] != 0:

2613

2411

logger.warning(

2614

"disabling client {} - Client last"

2615

" checker failed with error code {}"

2412

"disabling client {0} - Client "

2413

"last checker failed with error code {1}"

2616

2414

.format(client_name,

2617

2415

client["last_checker_status"]))

2618

2416

client["enabled"] = False

2621

2419

.utcnow()

2622

2420

+ client["timeout"])

2623

2421

logger.debug("Last checker succeeded,"

2624

" keeping {} enabled"

2422

" keeping {0} enabled"

2625

2423

.format(client_name))

2626

2424

try:

2627

2425

client["secret"] = (

2630

2428

["secret"]))

2631

2429

except PGPError:

2632

2430

# If decryption fails, we use secret from new settings

2633

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

2431

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

2634

2432

.format(client_name))

2635

2433

client["secret"] = (

2636

2434

client_settings[client_name]["secret"])

2644

2442

clients_data[client_name] = client_settings[client_name]

2645

2443

2646

2444

# Create all client objects

2647

for client_name, client in clients_data.items():

2445

for client_name, client in clients_data.iteritems():

2648

2446

tcp_server.clients[client_name] = client_class(

2649

name = client_name, settings = client,

2650

server_settings = server_settings)

2447

name = client_name, settings = client)

2651

2448

2652

2449

if not tcp_server.clients:

2653

2450

logger.warning("No clients defined")

2654

2451

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

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

2665

2464

del pidfilename

2666

2465

2667

2466

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

2733

2532

2734

2533

def cleanup():

2735

2534

"Cleanup function; run on exit"

2736

if zeroconf:

2737

service.cleanup()

2535

service.cleanup()

2738

2536

2739

2537

multiprocessing.active_children()

2740

wnull.close()

2741

2538

if not (tcp_server.clients or client_settings):

2742

2539

return

2743

2540

2754

2551

2755

2552

# A list of attributes that can not be pickled

2756

2553

# + secret.

2757

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

2758

"checker", "server_settings" }

2554

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

2555

"checker"))

2759

2556

for name, typ in (inspect.getmembers

2760

2557

(dbus.service.Object)):

2761

2558

exclude.add(name)

2784

2581

except NameError:

2785

2582

pass

2786

2583

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

2787

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

2584

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

2788

2585

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

2789

2586

else:

2790

2587

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

2791

2588

exc_info=e)

2792

raise

2589

raise e

2793

2590

2794

2591

# Delete all clients, and settings from config

2795

2592

while tcp_server.clients:

2819

2616

tcp_server.server_activate()

2820

2617

2821

2618

# Find out what port we got

2822

if zeroconf:

2823

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

2619

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

2824

2620

if use_ipv6:

2825

2621

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

2826

2622

" flowinfo %d, scope_id %d",

2832

2628

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

2833

2629

2834

2630

try:

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

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

2844

2639

2845

2640

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

2846

2641

lambda *args, **kwargs: