models.py 46.1 KB
Newer Older
1 2
# -*- coding: utf-8 -*-

3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
# Copyright 2014 Budapest University of Technology and Economics (BME IK)
#
# This file is part of CIRCLE Cloud.
#
# CIRCLE is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free
# Software Foundation, either version 3 of the License, or (at your option)
# any later version.
#
# CIRCLE is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along
# with CIRCLE.  If not, see <http://www.gnu.org/licenses/>.

20
from string import ascii_letters
21
from itertools import islice, ifilter, chain
22
from math import ceil
23
import logging
24
import random
25

26 27
from django.contrib.auth.models import User
from django.db import models
28
from django.forms import ValidationError
29
from django.utils.translation import ugettext_lazy as _
30
from firewall.fields import (MACAddressField, val_alfanum, val_reverse_domain,
31
                             val_ipv6_template, val_domain, val_ipv4,
32
                             val_domain_wildcard,
33
                             val_ipv6, val_mx,
34
                             IPNetworkField, IPAddressField)
35 36
from django.core.validators import MinValueValidator, MaxValueValidator
import django.conf
37
from django.db.models.signals import post_save, post_delete
38
from celery.exceptions import TimeoutError
39
from netaddr import IPSet, EUI, IPNetwork, IPAddress, ipv6_full
40

41
from common.models import method_cache, WorkerNotFound, HumanSortField
Bach Dániel committed
42
from firewall.tasks.local_tasks import reloadtask
43
from firewall.tasks.remote_tasks import get_dhcp_clients
44
from .iptables import IptRule
45
from acl.models import AclBase
46 47


48
logger = logging.getLogger(__name__)
49
settings = django.conf.settings.FIREWALL_SETTINGS
50 51


52 53
class Rule(models.Model):

54 55 56
    """
    A rule of a packet filter, changing the behavior of a host, vlan or
    firewall.
57

58 59
    Some rules accept or deny packets matching some criteria.
    Others set address translation or other free-form iptables parameters.
60 61
    """
    CHOICES_type = (('host', 'host'), ('firewall', 'firewall'),
Bach Dániel committed
62
                    ('vlan', 'vlan'))
63
    CHOICES_proto = (('tcp', 'tcp'), ('udp', 'udp'), ('icmp', 'icmp'))
64 65 66
    CHOICES_dir = (('out', _('out')), ('in', _('in')))
    CHOICES_action = (('accept', _('accept')), ('drop', _('drop')),
                      ('ignore', _('ignore')))
67

68
    direction = models.CharField(max_length=3, choices=CHOICES_dir,
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
                                 blank=False, verbose_name=_("direction"),
                                 help_text=_("If the rule matches egress "
                                             "or ingress packets."))
    description = models.TextField(blank=True, verbose_name=_('description'),
                                   help_text=_("Why is the rule needed, "
                                               "or how does it work."))
    foreign_network = models.ForeignKey(
        'VlanGroup', verbose_name=_("foreign network"),
        help_text=_("The group of vlans the matching packet goes to "
                    "(direction out) or from (in)."),
        related_name="ForeignRules")
    dport = models.IntegerField(
        blank=True, null=True, verbose_name=_("dest. port"),
        validators=[MinValueValidator(1), MaxValueValidator(65535)],
        help_text=_("Destination port number of packets that match."))
    sport = models.IntegerField(
        blank=True, null=True, verbose_name=_("source port"),
        validators=[MinValueValidator(1), MaxValueValidator(65535)],
        help_text=_("Source port number of packets that match."))
88 89
    weight = models.IntegerField(
        verbose_name=_("weight"),
90
        validators=[MinValueValidator(1), MaxValueValidator(65535)],
91 92
        help_text=_("Rule weight"),
        default=30000)
93
    proto = models.CharField(max_length=10, choices=CHOICES_proto,
94 95 96 97 98
                             blank=True, null=True, verbose_name=_("protocol"),
                             help_text=_("Protocol of packets that match."))
    extra = models.TextField(blank=True, verbose_name=_("extra arguments"),
                             help_text=_("Additional arguments passed "
                                         "literally to the iptables-rule."))
99 100 101 102
    action = models.CharField(max_length=10, choices=CHOICES_action,
                              default='drop', verbose_name=_('action'),
                              help_text=_("Accept, drop or ignore the "
                                          "matching packets."))
103 104 105 106
    owner = models.ForeignKey(User, blank=True, null=True,
                              verbose_name=_("owner"),
                              help_text=_("The user responsible for "
                                          "this rule."))
107

108 109
    nat = models.BooleanField(default=False, verbose_name=_("NAT"),
                              help_text=_("If network address translation "
110
                                          "should be done."))
111 112 113 114 115 116 117 118 119
    nat_external_port = models.IntegerField(
        blank=True, null=True,
        help_text=_("Rewrite destination port number to this if NAT is "
                    "needed."),
        validators=[MinValueValidator(1), MaxValueValidator(65535)])
    nat_external_ipv4 = IPAddressField(
        version=4, blank=True, null=True,
        verbose_name=_('external IPv4 address'))

120 121 122 123 124 125
    created_at = models.DateTimeField(
        auto_now_add=True,
        verbose_name=_("created at"))
    modified_at = models.DateTimeField(
        auto_now=True,
        verbose_name=_("modified at"))
126 127

    vlan = models.ForeignKey('Vlan', related_name="rules", blank=True,
128 129 130
                             null=True, verbose_name=_("vlan"),
                             help_text=_("Vlan the rule applies to "
                                         "(if type is vlan)."))
131
    vlangroup = models.ForeignKey('VlanGroup', related_name="rules",
132 133 134 135
                                  blank=True, null=True, verbose_name=_(
                                      "vlan group"),
                                  help_text=_("Group of vlans the rule "
                                              "applies to (if type is vlan)."))
136
    host = models.ForeignKey('Host', related_name="rules", blank=True,
137 138 139 140 141 142 143 144 145 146 147 148
                             verbose_name=_('host'), null=True,
                             help_text=_("Host the rule applies to "
                                         "(if type is host)."))
    hostgroup = models.ForeignKey(
        'Group', related_name="rules", verbose_name=_("host group"),
        blank=True, null=True, help_text=_("Group of hosts the rule applies "
                                           "to (if type is host)."))
    firewall = models.ForeignKey(
        'Firewall', related_name="rules", verbose_name=_("firewall"),
                                 help_text=_("Firewall the rule applies to "
                                             "(if type is firewall)."),
        blank=True, null=True)
149 150 151 152 153 154

    def __unicode__(self):
        return self.desc()

    def clean(self):
        fields = [self.vlan, self.vlangroup, self.host, self.hostgroup,
155
                  self.firewall]
156 157 158 159
        selected_fields = [field for field in fields if field]
        if len(selected_fields) > 1:
            raise ValidationError(_('Only one field can be selected.'))

160 161 162 163 164 165 166 167 168 169 170
    def get_external_ipv4(self):
        return (self.nat_external_ipv4
                if self.nat_external_ipv4 else self.host.get_external_ipv4())

    def get_external_port(self, proto='ipv4'):
        assert proto in ('ipv4', 'ipv6')
        if proto == 'ipv4' and self.nat_external_port:
            return self.nat_external_port
        else:
            return self.dport

171
    def desc(self):
172 173
        """Return a short string representation of the current rule.
        """
174 175
        return u'[%(type)s] %(src)s ▸ %(dst)s %(para)s %(desc)s' % {
            'type': self.r_type,
176
            'src': (unicode(self.foreign_network) if self.direction == 'in'
177
                    else self.r_type),
178
            'dst': (self.r_type if self.direction == 'out'
179
                    else unicode(self.foreign_network)),
180 181 182 183 184
            'para': ((("proto=%s " % self.proto) if self.proto else '') +
                     (("sport=%s " % self.sport) if self.sport else '') +
                     (("dport=%s " % self.dport) if self.dport else '')),
            'desc': self.description}

185 186 187 188 189 190 191 192 193
    @property
    def r_type(self):
        fields = [self.vlan, self.vlangroup, self.host, self.hostgroup,
                  self.firewall]
        for field in fields:
            if field is not None:
                return field.__class__.__name__.lower()
        return None

194 195 196 197
    @models.permalink
    def get_absolute_url(self):
        return ('network.rule', None, {'pk': self.pk})

198 199 200 201 202 203 204 205 206 207 208 209
    def get_chain_name(self, local, remote):
        if local:  # host or vlan
            if self.direction == 'in':
                # remote -> local
                return '%s_%s' % (remote.name, local.name)
            else:
                # local -> remote
                return '%s_%s' % (local.name, remote.name)
            # firewall rule
        elif self.firewall_id:
            return 'INPUT' if self.direction == 'in' else 'OUTPUT'

210 211
    def get_ipt_rules(self, host=None):
        # action
212
        action = 'LOG_ACC' if self.action == 'accept' else 'LOG_DROP'
213

214 215 216
        # 'chain_name': rule dict
        retval = {}

217 218 219 220 221
        # src and dst addresses
        src = None
        dst = None

        if host:
222
            ip = (host.ipv4, host.ipv6_with_host_prefixlen)
223 224 225 226
            if self.direction == 'in':
                dst = ip
            else:
                src = ip
227 228 229
            vlan = host.vlan
        elif self.vlan_id:
            vlan = self.vlan
230
        else:
231
            vlan = None
232

233 234 235
        if vlan and not vlan.managed:
            return retval

236 237
        # process foreign vlans
        for foreign_vlan in self.foreign_network.vlans.all():
238 239 240
            if not foreign_vlan.managed:
                continue

241
            r = IptRule(priority=self.weight, action=action,
242
                        proto=self.proto, extra=self.extra,
243
                        comment='Rule #%s' % self.pk,
244
                        src=src, dst=dst, dport=self.dport, sport=self.sport)
245
            chain_name = self.get_chain_name(local=vlan, remote=foreign_vlan)
246 247 248 249
            retval[chain_name] = r

        return retval

250 251 252 253 254 255 256
    @classmethod
    def portforwards(cls, host=None):
        qs = cls.objects.filter(dport__isnull=False, direction='in')
        if host is not None:
            qs = qs.filter(host=host)
        return qs

257 258 259 260 261 262 263 264
    class Meta:
        verbose_name = _("rule")
        verbose_name_plural = _("rules")
        ordering = (
            'direction',
            'proto',
            'sport',
            'dport',
265
            'nat_external_port',
266 267 268 269
            'host',
        )


270
class Vlan(AclBase, models.Model):
271 272 273 274 275 276 277 278 279 280 281 282

    """
    A vlan of the network,

    Networks controlled by this framework are split into separated subnets.
    These networks are izolated by the vlan (virtual lan) technology, which is
    commonly used by managed network switches to partition the network.

    Each vlan network has a unique identifier, a name, a unique IPv4 and IPv6
    range. The gateway also has an IP address in each range.
    """

283 284 285 286
    ACL_LEVELS = (
        ('user', _('user')),
        ('operator', _('operator')),
    )
287
    CHOICES_NETWORK_TYPE = (('public', _('public')),
288
                            ('portforward', _('portforward')))
289 290 291 292 293 294 295 296 297 298
    vid = models.IntegerField(unique=True,
                              verbose_name=_('VID'),
                              help_text=_('The vlan ID of the subnet.'),
                              validators=[MinValueValidator(1),
                                          MaxValueValidator(4095)])
    name = models.CharField(max_length=20,
                            unique=True,
                            verbose_name=_('Name'),
                            help_text=_('The short name of the subnet.'),
                            validators=[val_alfanum])
299 300 301 302 303
    network4 = IPNetworkField(unique=False,
                              version=4,
                              verbose_name=_('IPv4 address/prefix'),
                              help_text=_(
                                  'The IPv4 address and the prefix length '
304
                                  'of the gateway. '
305 306 307 308
                                  'Recommended value is the last '
                                  'valid address of the subnet, '
                                  'for example '
                                  '10.4.255.254/16 for 10.4.0.0/16.'))
309 310 311 312 313 314
    host_ipv6_prefixlen = models.IntegerField(
        verbose_name=_('IPv6 prefixlen/host'),
        help_text=_('The prefix length of the subnet assigned to a host. '
                    'For example /112 = 65536 addresses/host.'),
        default=112,
        validators=[MinValueValidator(1), MaxValueValidator(128)])
315 316 317 318 319 320 321 322
    network6 = IPNetworkField(unique=False,
                              version=6,
                              null=True,
                              blank=True,
                              verbose_name=_('IPv6 address/prefix'),
                              help_text=_(
                                  'The IPv6 address and the prefix length '
                                  'of the gateway.'))
323
    snat_ip = models.GenericIPAddressField(protocol='ipv4', blank=True,
324 325 326 327 328 329 330 331
                                           null=True,
                                           verbose_name=_('NAT IP address'),
                                           help_text=_(
                                               'Common IPv4 address used for '
                                               'address translation of '
                                               'connections to the networks '
                                               'selected below '
                                               '(typically to the internet).'))
332
    snat_to = models.ManyToManyField('self', symmetrical=False, blank=True,
333 334 335 336 337 338 339
                                     null=True, verbose_name=_('NAT to'),
                                     help_text=_(
                                         'Connections to these networks '
                                         'should be network address '
                                         'translated, i.e. their source '
                                         'address is rewritten to the value '
                                         'of NAT IP address.'))
340 341
    network_type = models.CharField(choices=CHOICES_NETWORK_TYPE,
                                    verbose_name=_('network type'),
342
                                    default='portforward',
343
                                    max_length=20)
344
    managed = models.BooleanField(default=True, verbose_name=_('managed'))
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
    description = models.TextField(blank=True, verbose_name=_('description'),
                                   help_text=_(
                                       'Description of the goals and elements '
                                       'of the vlan network.'))
    comment = models.TextField(blank=True, verbose_name=_('comment'),
                               help_text=_(
                                   'Notes, comments about the network'))
    domain = models.ForeignKey('Domain', verbose_name=_('domain name'),
                               help_text=_('Domain name of the members of '
                                           'this network.'))
    reverse_domain = models.TextField(
        validators=[val_reverse_domain],
        verbose_name=_('reverse domain'),
        help_text=_('Template of the IPv4 reverse domain name that '
                    'should be generated for each host. The template '
                    'should contain four tokens: "%(a)d", "%(b)d", '
                    '"%(c)d", and "%(d)d", representing the four bytes '
                    'of the address, respectively, in decimal notation. '
                    'For example, the template for the standard reverse '
                    'address is: "%(d)d.%(c)d.%(b)d.%(a)d.in-addr.arpa".'),
        default="%(d)d.%(c)d.%(b)d.%(a)d.in-addr.arpa")
366
    ipv6_template = models.TextField(
367 368 369 370 371 372 373 374 375 376 377 378 379 380
        blank=True,
        help_text=_('Template for translating IPv4 addresses to IPv6. '
                    'Automatically generated hosts in dual-stack networks '
                    'will get this address. The template '
                    'can contain four tokens: "%(a)d", "%(b)d", '
                    '"%(c)d", and "%(d)d", representing the four bytes '
                    'of the IPv4 address, respectively, in decimal notation. '
                    'Moreover you can use any standard printf format '
                    'specification like %(a)02x to get the first byte as two '
                    'hexadecimal digits. Usual choices for mapping '
                    '198.51.100.0/24 to 2001:0DB8:1:1::/64 would be '
                    '"2001:0DB8:51:1:1:%(d)d::" and '
                    '"2001:0DB8:51:1:1:%(d)x00::".'),
        validators=[val_ipv6_template], verbose_name=_('ipv6 template'))
381 382 383 384 385 386 387 388 389 390 391 392 393
    dhcp_pool = models.TextField(blank=True, verbose_name=_('DHCP pool'),
                                 help_text=_(
                                     'The address range of the DHCP pool: '
                                     'empty for no DHCP service, "manual" for '
                                     'no DHCP pool, or the first and last '
                                     'address of the range separated by a '
                                     'space.'))
    created_at = models.DateTimeField(auto_now_add=True,
                                      verbose_name=_('created at'))
    owner = models.ForeignKey(User, blank=True, null=True,
                              verbose_name=_('owner'))
    modified_at = models.DateTimeField(auto_now=True,
                                       verbose_name=_('modified at'))
394

395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
    def clean(self):
        super(Vlan, self).clean()
        if self.ipv6_template:
            if not self.network6:
                raise ValidationError(
                    _("You cannot specify an IPv6 template if there is no "
                      "IPv6 network set."))
            for i in (self.network4[1], self.network4[-1]):
                i6 = self.convert_ipv4_to_ipv6(i)
                if i6 not in self.network6:
                    raise ValidationError(
                        _("%(ip6)s (translated from %(ip4)s) is outside of "
                          "the IPv6 network.") % {"ip4": i, "ip6": i6})
        if not self.ipv6_template and self.network6:
            # come up with some sensible default
            self.ipv6_template = self._magic_ipv6_template()
        host4_bytes = int(ceil((32 - self.network4.prefixlen) / 8))
        host6_bytes = int(ceil((128 - self.network6.prefixlen) / 8))
        if host4_bytes > host6_bytes:
            raise ValidationError(
                _("IPv6 network is too small to map IPv4 addresses to it."))

    def _magic_ipv6_template(self):
            host4_bytes = int(ceil((32 - self.network4.prefixlen) / 8))
            host6_bytes = int(ceil((128 - self.network6.prefixlen) / 8))
            letters = ascii_letters[4-host4_bytes:4]
            remove = host6_bytes // 2
            ipstr = self.network6.network.format(ipv6_full)
            s = ipstr.split(":")[0:-remove]
            if 2 * (host4_bytes + 1) < host6_bytes:  # use verbose format
                for i in letters:
                    s.append("%({})d".format(i))
            else:  # use short format
                remain = host6_bytes
                for i in letters:
                    if remain % 2 == 1:  # can use last half word
                        if s[-1].endswith("00"):
                            s[-1] = s[-1][:-2]
                        s[-1] += "%({})02x".format(i)
                    else:
                        s.append("%({})02x00".format(i))
                    remain -= 1
            if host6_bytes > host4_bytes:
                s.append(":")
            return ":".join(s)

441
    def __unicode__(self):
442 443
        return "%s - %s" % ("managed" if self.managed else "unmanaged",
                            self.name)
444

445 446 447 448
    @models.permalink
    def get_absolute_url(self):
        return ('network.vlan', None, {'vid': self.vid})

449 450 451 452 453 454
    def get_random_addresses(self, used_v4, buffer_size=100, max_hosts=10000):
        addresses = islice(self.network4.iter_hosts(), max_hosts)
        unused_addresses = list(islice(
            ifilter(lambda x: x not in used_v4, addresses), buffer_size))
        random.shuffle(unused_addresses)
        return unused_addresses
455

456
    def get_new_address(self):
457
        hosts = self.host_set
458 459 460
        used_v4 = IPSet(hosts.values_list('ipv4', flat=True))
        used_v6 = IPSet(hosts.exclude(ipv6__isnull=True)
                        .values_list('ipv6', flat=True))
461

462 463 464 465
        for ipv4 in self.get_random_addresses(used_v4):
            logger.debug("Found unused IPv4 address %s.", ipv4)
            ipv6 = None
            if self.network6 is not None:
466
                ipv6 = self.convert_ipv4_to_ipv6(ipv4)
467 468 469 470 471
                if ipv6 in used_v6:
                    continue
                else:
                    logger.debug("Found unused IPv6 address %s.", ipv6)
            return {'ipv4': ipv4, 'ipv6': ipv6}
472 473
        else:
            raise ValidationError(_("All IP addresses are already in use."))
474

475 476
    def convert_ipv4_to_ipv6(self, ipv4):
        """Convert IPv4 address string to IPv6 address string."""
477 478
        if isinstance(ipv4, basestring):
            ipv4 = IPAddress(ipv4, 4)
479 480 481
        nums = {ascii_letters[i]: int(ipv4.words[i]) for i in range(4)}
        return IPAddress(self.ipv6_template % nums)

482 483 484 485 486 487 488
    def get_dhcp_clients(self):
        macs = set(i.mac for i in self.host_set.all())
        return [{"mac": k, "ip": v["ip"], "hostname": v["hostname"]}
                for k, v in chain(*(fw.get_dhcp_clients().iteritems()
                                    for fw in Firewall.objects.all() if fw))
                if v["interface"] == self.name and EUI(k) not in macs]

489

490
class VlanGroup(models.Model):
491 492 493 494 495 496
    """
    A group of Vlans.
    """

    name = models.CharField(max_length=20, unique=True, verbose_name=_('name'),
                            help_text=_('The name of the group.'))
497
    vlans = models.ManyToManyField('Vlan', symmetrical=False, blank=True,
498 499 500 501 502 503 504 505 506 507 508
                                   null=True, verbose_name=_('vlans'),
                                   help_text=_('The vlans which are members '
                                               'of the group.'))
    description = models.TextField(blank=True, verbose_name=_('description'),
                                   help_text=_('Description of the group.'))
    owner = models.ForeignKey(User, blank=True, null=True,
                              verbose_name=_('owner'))
    created_at = models.DateTimeField(auto_now_add=True,
                                      verbose_name=_('created at'))
    modified_at = models.DateTimeField(auto_now=True,
                                       verbose_name=_('modified at'))
509 510 511 512

    def __unicode__(self):
        return self.name

513 514 515 516 517
    @models.permalink
    def get_absolute_url(self):
        return ('network.vlan_group', None, {'pk': self.pk})


518
class Group(models.Model):
519 520 521 522 523 524 525 526 527 528 529 530 531
    """
    A group of hosts.
    """
    name = models.CharField(max_length=20, unique=True, verbose_name=_('name'),
                            help_text=_('The name of the group.'))
    description = models.TextField(blank=True, verbose_name=_('description'),
                                   help_text=_('Description of the group.'))
    owner = models.ForeignKey(User, blank=True, null=True,
                              verbose_name=_('owner'))
    created_at = models.DateTimeField(auto_now_add=True,
                                      verbose_name=_('created at'))
    modified_at = models.DateTimeField(auto_now=True,
                                       verbose_name=_('modified at'))
532 533 534 535

    def __unicode__(self):
        return self.name

536 537 538 539 540
    @models.permalink
    def get_absolute_url(self):
        return ('network.group', None, {'pk': self.pk})


541
class Host(models.Model):
542 543 544 545
    """
    A host of the network.
    """

546
    hostname = models.CharField(max_length=40,
547 548 549 550 551
                                verbose_name=_('hostname'),
                                help_text=_('The alphanumeric hostname of '
                                            'the host, the first part of '
                                            'the FQDN.'),
                                validators=[val_alfanum])
552
    normalized_hostname = HumanSortField(monitor='hostname', max_length=80)
553
    reverse = models.CharField(max_length=40, validators=[val_domain],
554 555 556 557 558 559 560 561 562
                               verbose_name=_('reverse'),
                               help_text=_('The fully qualified reverse '
                                           'hostname of the host, if '
                                           'different than hostname.domain.'),
                               blank=True, null=True)
    mac = MACAddressField(unique=True, verbose_name=_('MAC address'),
                          help_text=_('The MAC (Ethernet) address of the '
                                      'network interface. For example: '
                                      '99:AA:BB:CC:DD:EE.'))
563 564 565 566
    ipv4 = IPAddressField(version=4, unique=True,
                          verbose_name=_('IPv4 address'),
                          help_text=_('The real IPv4 address of the '
                                      'host, for example 10.5.1.34.'))
567
    external_ipv4 = IPAddressField(
568
        version=4, blank=True, null=True,
569 570 571
        verbose_name=_('WAN IPv4 address'),
        help_text=_('The public IPv4 address of the host on the wide '
                    'area network, if different.'))
572 573 574 575 576
    ipv6 = IPAddressField(version=6, unique=True,
                          blank=True, null=True,
                          verbose_name=_('IPv6 address'),
                          help_text=_('The global IPv6 address of the host'
                                      ', for example 2001:db:88:200::10.'))
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594
    shared_ip = models.BooleanField(default=False, verbose_name=_('shared IP'),
                                    help_text=_(
                                        'If the given WAN IPv4 address is '
                                        'used by multiple hosts.'))
    description = models.TextField(blank=True, verbose_name=_('description'),
                                   help_text=_('What is this host for, what '
                                               'kind of machine is it.'))
    comment = models.TextField(blank=True,
                               verbose_name=_('Notes'))
    location = models.TextField(blank=True, verbose_name=_('location'),
                                help_text=_(
                                    'The physical location of the machine.'))
    vlan = models.ForeignKey('Vlan', verbose_name=_('vlan'),
                             help_text=_(
                                 'Vlan network that the host is part of.'))
    owner = models.ForeignKey(User, verbose_name=_('owner'),
                              help_text=_(
                                  'The person responsible for this host.'))
595
    groups = models.ManyToManyField('Group', symmetrical=False, blank=True,
596 597 598 599 600 601 602
                                    null=True, verbose_name=_('groups'),
                                    help_text=_(
                                        'Host groups the machine is part of.'))
    created_at = models.DateTimeField(auto_now_add=True,
                                      verbose_name=_('created at'))
    modified_at = models.DateTimeField(auto_now=True,
                                       verbose_name=_('modified at'))
603

604 605
    class Meta(object):
        unique_together = ('hostname', 'vlan')
606
        ordering = ('normalized_hostname', 'vlan')
607

608 609 610
    def __unicode__(self):
        return self.hostname

611 612
    @property
    def incoming_rules(self):
613
        return self.rules.filter(direction='in')
614

615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
    @staticmethod
    def create_ipnetwork(ip, prefixlen):
        try:
            net = IPNetwork(ip)
            net.prefixlen = prefixlen
        except TypeError:
            return None
        else:
            return net

    @property
    def ipv4_with_vlan_prefixlen(self):
        return Host.create_ipnetwork(
            self.ipv4, self.vlan.network4.prefixlen)

    @property
    def ipv6_with_vlan_prefixlen(self):
        return Host.create_ipnetwork(
            self.ipv6, self.vlan.network6.prefixlen)

635
    @property
636 637 638
    def ipv6_with_host_prefixlen(self):
        return Host.create_ipnetwork(
            self.ipv6, self.vlan.host_ipv6_prefixlen)
639 640 641 642 643 644 645

    def get_external_ipv4(self):
        return self.external_ipv4 if self.external_ipv4 else self.ipv4

    @property
    def behind_nat(self):
        return self.vlan.network_type != 'public'
646

647
    def clean(self):
648 649 650
        if (self.external_ipv4 and not self.shared_ip and self.behind_nat
                and Host.objects.exclude(id=self.id).filter(
                    external_ipv4=self.external_ipv4)):
651
            raise ValidationError(_("If shared_ip has been checked, "
652 653
                                    "external_ipv4 has to be unique."))
        if Host.objects.exclude(id=self.id).filter(external_ipv4=self.ipv4):
654
            raise ValidationError(_("You can't use another host's NAT'd "
655
                                    "address as your own IPv4."))
656 657 658

    def save(self, *args, **kwargs):
        if not self.id and self.ipv6 == "auto":
659
            self.ipv6 = self.vlan.convert_ipv4_to_ipv6(self.ipv4)
660
        self.full_clean()
661

662
        super(Host, self).save(*args, **kwargs)
663

Bach Dániel committed
664
        # IPv4
665
        if self.ipv4 is not None:
Bach Dániel committed
666 667 668 669
            if not self.shared_ip and self.external_ipv4:  # DMZ
                ipv4 = self.external_ipv4
            else:
                ipv4 = self.ipv4
Bach Dániel committed
670 671 672
            # update existing records
            affected_records = Record.objects.filter(
                host=self, name=self.hostname,
Bach Dániel committed
673
                type='A').update(address=ipv4)
Bach Dániel committed
674 675
            # create new record
            if affected_records == 0:
676 677 678 679 680
                Record(host=self,
                       name=self.hostname,
                       domain=self.vlan.domain,
                       address=self.ipv4,
                       owner=self.owner,
Bach Dániel committed
681
                       description='created by host.save()',
682 683
                       type='A').save()

Bach Dániel committed
684 685 686 687 688 689 690 691
        # IPv6
        if self.ipv6 is not None:
            # update existing records
            affected_records = Record.objects.filter(
                host=self, name=self.hostname,
                type='AAAA').update(address=self.ipv6)
            # create new record
            if affected_records == 0:
692 693 694 695 696
                Record(host=self,
                       name=self.hostname,
                       domain=self.vlan.domain,
                       address=self.ipv6,
                       owner=self.owner,
Bach Dániel committed
697
                       description='created by host.save()',
698
                       type='AAAA').save()
699

Bach Dániel committed
700 701 702 703
    def get_network_config(self):
        interface = {'addresses': []}

        if self.ipv4 and self.vlan.network4:
704
            interface['addresses'].append(str(self.ipv4_with_vlan_prefixlen))
Bach Dániel committed
705 706 707
            interface['gw4'] = str(self.vlan.network4.ip)

        if self.ipv6 and self.vlan.network6:
708
            interface['addresses'].append(str(self.ipv6_with_vlan_prefixlen))
Bach Dániel committed
709 710 711 712
            interface['gw6'] = str(self.vlan.network6.ip)

        return interface

713
    def enable_net(self):
714 715
        for i in settings.get('default_host_groups', []):
            self.groups.add(Group.objects.get(name=i))
716

717 718 719 720
    def _get_ports_used(self, proto):
        """
        Gives a list of port numbers used for the public IP address of current
        host for the given protocol.
721

722 723 724 725
        :param proto: The transport protocol of the generated port (tcp|udp).
        :type proto: str.
        :returns: list -- list of int port numbers used.
        """
726 727 728 729 730
        if self.behind_nat:
            ports = Rule.objects.filter(
                host__external_ipv4=self.external_ipv4,
                nat=True,
                proto=proto).values_list('nat_external_port', flat=True)
731
        else:
732 733 734
            ports = self.rules.filter(proto=proto).values_list(
                'dport', flat=True)
        return set(ports)
735 736 737 738 739 740 741 742

    def _get_random_port(self, proto, used_ports=None):
        """
        Get a random unused port for given protocol for current host's public
        IP address.

        :param proto: The transport protocol of the generated port (tcp|udp).
        :type proto: str.
743
        :param used_ports: Optional set of used ports returned by
744 745 746 747 748 749 750 751 752 753 754 755 756
                           _get_ports_used.
        :returns: int -- the generated port number.
        :raises: ValidationError
        """
        if used_ports is None:
            used_ports = self._get_ports_used(proto)

        public = random.randint(1024, 21000)  # pick a random port
        if public in used_ports:  # if it's in use, select smallest free one
            for i in range(1024, 21000) + range(24000, 65535):
                if i not in used_ports:
                    public = i
                    break
757
            else:
758 759
                raise ValidationError(
                    _("All %s ports are already in use.") % proto)
760
        return public
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780

    def add_port(self, proto, public=None, private=None):
        """
        Allow inbound traffic to a port.

        If the host uses a shared IP address, also set up port forwarding.

        :param proto: The transport protocol (tcp|udp).
        :type proto: str.
        :param public: Preferred public port number for forwarding (optional).
        :param private: Port number of host in subject.
        """
        assert proto in ('tcp', 'udp', )
        if public:
            if public in self._get_ports_used(proto):
                raise ValidationError(
                    _("Port %(proto)s %(public)s is already in use.") %
                    {'proto': proto, 'public': public})
        else:
            public = self._get_random_port(proto)
781

782 783 784 785 786 787
        try:
            vgname = settings["default_vlangroup"]
            vg = VlanGroup.objects.get(name=vgname)
        except VlanGroup.DoesNotExist as e:
            logger.error('Host.add_port: default_vlangroup %s missing. %s',
                         vgname, unicode(e))
788
        else:
789
            rule = Rule(direction='in', owner=self.owner, dport=private,
790
                        proto=proto, nat=False, action='accept',
791 792
                        host=self, foreign_network=vg)
            if self.behind_nat:
793 794 795
                if public < 1024:
                    raise ValidationError(
                        _("Only ports above 1024 can be used."))
796 797
                rule.nat_external_port = public
                rule.nat = True
798 799
            rule.full_clean()
            rule.save()
800 801

    def del_port(self, proto, private):
802 803 804 805 806 807 808 809 810 811
        """
        Remove rules about inbound traffic to a given port.

        If the host uses a shared IP address, also set up port forwarding.

        :param proto: The transport protocol (tcp|udp).
        :type proto: str.
        :param private: Port number of host in subject.
        """

812
        self.rules.filter(proto=proto, dport=private).delete()
813

814
    def get_hostname(self, proto, public=True):
815
        """
816
        Get a private or public hostname for host.
817 818 819 820 821

        :param proto: The IP version (ipv4|ipv6).
        :type proto: str.
        """
        assert proto in ('ipv6', 'ipv4', )
Bach Dániel committed
822 823
        if self.reverse:
            return self.reverse
824 825
        try:
            if proto == 'ipv6':
826 827
                res = self.record_set.filter(type='AAAA',
                                             address=self.ipv6)
828
            elif proto == 'ipv4':
829 830 831
                if self.behind_nat and public:
                    res = Record.objects.filter(
                        type='A', address=self.get_external_ipv4())
832
                    if res.count() < 1:
833
                        return unicode(self.get_external_ipv4())
834
                else:
835 836 837
                    res = self.record_set.filter(type='A',
                                                 address=self.ipv4)
            return unicode(res[0].fqdn)
838
        except:
839
            return None
840 841

    def list_ports(self):
842 843 844
        """
        Return a list of ports with forwarding rules set.
        """
845
        retval = []
846
        for rule in Rule.portforwards(host=self):
847 848
            forward = {
                'proto': rule.proto,
849
                'private': rule.dport,
850 851 852 853 854
            }

            if True:      # ipv4
                forward['ipv4'] = {
                    'host': self.get_hostname(proto='ipv4'),
855
                    'port': rule.get_external_port(proto='ipv4'),
856
                    'pk': rule.pk,
857
                }
858
            if self.ipv6:  # ipv6
859 860
                forward['ipv6'] = {
                    'host': self.get_hostname(proto='ipv6'),
861
                    'port': rule.get_external_port(proto='ipv6'),
862
                    'pk': rule.pk,
863 864 865 866 867
                }
            retval.append(forward)
        return retval

    def get_fqdn(self):
868 869 870
        """
        Get fully qualified host name of host.
        """
871
        return self.get_hostname('ipv4', public=False)
872

873 874 875 876 877 878 879
    def get_public_endpoints(self, port, protocol='tcp'):
        """Get public IPv4 and IPv6 endpoints for local port.

        Optionally the required protocol (e.g. TCP, UDP) can be specified.
        """
        endpoints = {}
        # IPv4
880
        ports = self.incoming_rules.filter(action='accept', dport=port,
881 882 883 884 885
                                           proto=protocol)
        public_port = (ports[0].get_external_port(proto='ipv4')
                       if ports.exists() else None)
        endpoints['ipv4'] = ((self.get_external_ipv4(), public_port)
                             if public_port else
886 887
                             None)
        # IPv6
888
        endpoints['ipv6'] = (self.ipv6, port) if public_port else None
889 890
        return endpoints

891 892 893 894
    @models.permalink
    def get_absolute_url(self):
        return ('network.host', None, {'pk': self.pk})

895 896 897 898 899 900 901 902 903 904 905
    @property
    def eui(self):
        return EUI(self.mac)

    @property
    def hw_vendor(self):
        try:
            return self.eui.oui.registration().org
        except:
            return None

906 907

class Firewall(models.Model):
908 909
    name = models.CharField(max_length=20, unique=True,
                            verbose_name=_('name'))
910 911 912 913

    def __unicode__(self):
        return self.name

914
    @method_cache(30)
915
    def get_remote_queue_name(self, queue_id="firewall"):
916 917 918 919 920 921 922 923 924 925 926 927
        """Returns the name of the remote celery queue for this node.

        Throws Exception if there is no worker on the queue.
        The result may include dead queues because of caching.
        """
        from .tasks.remote_tasks import check_queue

        if check_queue(self.name, queue_id, None):
            return self.name + "." + queue_id
        else:
            raise WorkerNotFound()

928 929 930 931 932 933 934 935
    @method_cache(20)
    def get_dhcp_clients(self):
        try:
            return get_dhcp_clients.apply_async(
                queue=self.get_remote_queue_name(), expires=60).get(timeout=2)
        except TimeoutError:
            return None

936

937
class Domain(models.Model):
938 939 940 941 942 943 944 945 946
    name = models.CharField(max_length=40, validators=[val_domain],
                            verbose_name=_('name'))
    owner = models.ForeignKey(User, verbose_name=_('owner'))
    created_at = models.DateTimeField(auto_now_add=True,
                                      verbose_name=_('created_at'))
    modified_at = models.DateTimeField(auto_now=True,
                                       verbose_name=_('modified_at'))
    ttl = models.IntegerField(default=600, verbose_name=_('ttl'))
    description = models.TextField(blank=True, verbose_name=_('description'))
947 948 949 950

    def __unicode__(self):
        return self.name

951 952 953 954 955
    @models.permalink
    def get_absolute_url(self):
        return ('network.domain', None, {'pk': self.pk})


956 957
class Record(models.Model):
    CHOICES_type = (('A', 'A'), ('CNAME', 'CNAME'), ('AAAA', 'AAAA'),
Bach Dániel committed
958
                    ('MX', 'MX'), ('NS', 'NS'), ('PTR', 'PTR'), ('TXT', 'TXT'))
959
    name = models.CharField(max_length=40, validators=[val_domain_wildcard],
960 961 962 963 964 965
                            blank=True, null=True, verbose_name=_('name'))
    domain = models.ForeignKey('Domain', verbose_name=_('domain'))
    host = models.ForeignKey('Host', blank=True, null=True,
                             verbose_name=_('host'))
    type = models.CharField(max_length=6, choices=CHOICES_type,
                            verbose_name=_('type'))
966
    address = models.CharField(max_length=400,
967 968 969 970 971 972 973 974
                               verbose_name=_('address'))
    ttl = models.IntegerField(default=600, verbose_name=_('ttl'))
    owner = models.ForeignKey(User, verbose_name=_('owner'))
    description = models.TextField(blank=True, verbose_name=_('description'))
    created_at = models.DateTimeField(auto_now_add=True,
                                      verbose_name=_('created_at'))
    modified_at = models.DateTimeField(auto_now=True,
                                       verbose_name=_('modified_at'))
975 976 977 978 979

    def __unicode__(self):
        return self.desc()

    def desc(self):
980
        return u' '.join([self.fqdn, self.type, self.address])
981 982 983 984 985

    def save(self, *args, **kwargs):
        self.full_clean()
        super(Record, self).save(*args, **kwargs)

986 987
    def _validate_record(self):
        """Validate a record."""
988 989
        if not self.address:
            raise ValidationError(_("Address must be specified!"))
990 991 992 993 994 995 996 997 998 999 1000 1001

        try:
            validator = {
                'A': val_ipv4,
                'AAAA': val_ipv6,
                'CNAME': val_domain,
                'MX': val_mx,
                'NS': val_domain,
                'PTR': val_domain,
                'TXT': None,
            }[self.type]
        except KeyError:
1002
            raise ValidationError(_("Unknown record type."))
1003 1004 1005
        else:
            if validator:
                validator(self.address)
1006

1007
    def clean(self):
1008 1009
        """Validate the Record to be saved.
        """
1010 1011 1012
        if self.name:
            self.name = self.name.rstrip(".")    # remove trailing dots

1013
        self._validate_record()
1014

1015 1016
    @property
    def fqdn(self):
1017 1018 1019 1020
        if self.name:
            return '%s.%s' % (self.name, self.domain.name)
        else:
            return self.domain.name
1021

1022 1023 1024 1025
    @models.permalink
    def get_absolute_url(self):
        return ('network.record', None, {'pk': self.pk})

1026 1027 1028 1029 1030 1031
    class Meta:
        ordering = (
            'domain',
            'name',
        )

1032

1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
class SwitchPort(models.Model):
    untagged_vlan = models.ForeignKey('Vlan',
                                      related_name='untagged_ports',
                                      verbose_name=_('untagged vlan'))
    tagged_vlans = models.ForeignKey('VlanGroup', blank=True, null=True,
                                     related_name='tagged_ports',
                                     verbose_name=_('tagged vlans'))
    description = models.TextField(blank=True, verbose_name=_('description'))
    created_at = models.DateTimeField(auto_now_add=True,
                                      verbose_name=_('created_at'))
    modified_at = models.DateTimeField(auto_now=True,
                                       verbose_name=_('modified_at'))

    def __unicode__(self):
        devices = ','.join(self.ethernet_devices.values_list('name',
                                                             flat=True))
        tagged_vlans = self.tagged_vlans.name if self.tagged_vlans else ''
        return 'devices=%s untagged=%s tagged=%s' % (devices,
                                                     self.untagged_vlan,
                                                     tagged_vlans)

1054 1055 1056 1057
    @models.permalink
    def get_absolute_url(self):
        return ('network.switch_port', None, {'pk': self.pk})

1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077

class EthernetDevice(models.Model):
    name = models.CharField(max_length=20,
                            unique=True,
                            verbose_name=_('interface'),
                            help_text=_('The name of network interface the '
                                        'gateway should serve this network '
                                        'on. For example eth2.'))
    switch_port = models.ForeignKey('SwitchPort',
                                    related_name='ethernet_devices',
                                    verbose_name=_('switch port'))
    created_at = models.DateTimeField(auto_now_add=True,
                                      verbose_name=_('created_at'))
    modified_at = models.DateTimeField(auto_now=True,
                                       verbose_name=_('modified_at'))

    def __unicode__(self):
        return self.name


1078
class BlacklistItem(models.Model):
1079 1080
    CHOICES_type = (('permban', 'permanent ban'), ('tempban', 'temporary ban'),
                    ('whitelist', 'whitelist'), ('tempwhite', 'tempwhite'))
1081
    ipv4 = models.GenericIPAddressField(protocol='ipv4', unique=True)
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096
    host = models.ForeignKey('Host', blank=True, null=True,
                             verbose_name=_('host'))
    reason = models.TextField(blank=True, verbose_name=_('reason'))
    snort_message = models.TextField(blank=True,
                                     verbose_name=_('short message'))
    type = models.CharField(
        max_length=10,
        choices=CHOICES_type,
        default='tempban',
        verbose_name=_('type')
    )
    created_at = models.DateTimeField(auto_now_add=True,
                                      verbose_name=_('created_at'))
    modified_at = models.DateTimeField(auto_now=True,
                                       verbose_name=_('modified_at'))
1097 1098 1099

    def save(self, *args, **kwargs):
        self.full_clean()
1100
        super(BlacklistItem, self).save(*args, **kwargs)
1101

1102 1103 1104
    def __unicode__(self):
        return self.ipv4

1105 1106 1107 1108
    class Meta(object):
        verbose_name = _('blacklist item')
        verbose_name_plural = _('blacklist')

1109 1110 1111 1112 1113
    @models.permalink
    def get_absolute_url(self):
        return ('network.blacklist', None, {'pk': self.pk})


1114
def send_task(sender, instance, created=False, **kwargs):
1115
    reloadtask.apply_async(queue='localhost.man', args=[sender.__name__])
1116 1117


1118 1119
for sender in [Host, Rule, Domain, Record, Vlan, Firewall, Group,
               BlacklistItem, SwitchPort, EthernetDevice]:
1120 1121
    post_save.connect(send_task, sender=sender)
    post_delete.connect(send_task, sender=sender)