models.py 40.6 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 itertools import islice, ifilter
21
import logging
22
from netaddr import IPSet, EUI, IPNetwork
23

24 25
from django.contrib.auth.models import User
from django.db import models
26
from django.forms import ValidationError
27
from django.utils.translation import ugettext_lazy as _
28
from firewall.fields import (MACAddressField, val_alfanum, val_reverse_domain,
29
                             val_ipv6_template, val_domain, val_ipv4,
30
                             val_domain_wildcard,
31 32
                             val_ipv6, val_mx, convert_ipv4_to_ipv6,
                             IPNetworkField, IPAddressField)
33 34
from django.core.validators import MinValueValidator, MaxValueValidator
import django.conf
35
from django.db.models.signals import post_save, post_delete
36 37
import random

38
from common.models import HumanSortField
Bach Dániel committed
39
from firewall.tasks.local_tasks import reloadtask
40
from .iptables import IptRule
41
from acl.models import AclBase
42
logger = logging.getLogger(__name__)
43
settings = django.conf.settings.FIREWALL_SETTINGS
44 45


46 47
class Rule(models.Model):

48 49 50
    """
    A rule of a packet filter, changing the behavior of a host, vlan or
    firewall.
51

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

62
    direction = models.CharField(max_length=3, choices=CHOICES_dir,
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
                                 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."))
82 83
    weight = models.IntegerField(
        verbose_name=_("weight"),
84
        validators=[MinValueValidator(1), MaxValueValidator(65535)],
85 86
        help_text=_("Rule weight"),
        default=30000)
87
    proto = models.CharField(max_length=10, choices=CHOICES_proto,
88 89 90 91 92
                             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."))
93 94 95 96
    action = models.CharField(max_length=10, choices=CHOICES_action,
                              default='drop', verbose_name=_('action'),
                              help_text=_("Accept, drop or ignore the "
                                          "matching packets."))
97 98 99 100
    owner = models.ForeignKey(User, blank=True, null=True,
                              verbose_name=_("owner"),
                              help_text=_("The user responsible for "
                                          "this rule."))
101

102 103
    nat = models.BooleanField(default=False, verbose_name=_("NAT"),
                              help_text=_("If network address translation "
104
                                          "should be done."))
105 106 107 108 109 110 111 112 113
    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'))

114 115 116 117 118 119
    created_at = models.DateTimeField(
        auto_now_add=True,
        verbose_name=_("created at"))
    modified_at = models.DateTimeField(
        auto_now=True,
        verbose_name=_("modified at"))
120 121

    vlan = models.ForeignKey('Vlan', related_name="rules", blank=True,
122 123 124
                             null=True, verbose_name=_("vlan"),
                             help_text=_("Vlan the rule applies to "
                                         "(if type is vlan)."))
125
    vlangroup = models.ForeignKey('VlanGroup', related_name="rules",
126 127 128 129
                                  blank=True, null=True, verbose_name=_(
                                      "vlan group"),
                                  help_text=_("Group of vlans the rule "
                                              "applies to (if type is vlan)."))
130
    host = models.ForeignKey('Host', related_name="rules", blank=True,
131 132 133 134 135 136 137 138 139 140 141 142
                             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)
143 144 145 146 147 148

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

    def clean(self):
        fields = [self.vlan, self.vlangroup, self.host, self.hostgroup,
149
                  self.firewall]
150 151 152 153
        selected_fields = [field for field in fields if field]
        if len(selected_fields) > 1:
            raise ValidationError(_('Only one field can be selected.'))

154 155 156 157 158 159 160 161 162 163 164
    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

165
    def desc(self):
166 167
        """Return a short string representation of the current rule.
        """
168 169
        return u'[%(type)s] %(src)s ▸ %(dst)s %(para)s %(desc)s' % {
            'type': self.r_type,
170
            'src': (unicode(self.foreign_network) if self.direction == 'in'
171
                    else self.r_type),
172
            'dst': (self.r_type if self.direction == 'out'
173
                    else unicode(self.foreign_network)),
174 175 176 177 178
            '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}

179 180 181 182 183 184 185 186 187
    @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

188 189 190 191
    @models.permalink
    def get_absolute_url(self):
        return ('network.rule', None, {'pk': self.pk})

192 193 194 195 196 197 198 199 200 201 202
    @staticmethod
    def get_chain_name(local, remote, direction):
        if direction == 'in':
            # remote -> local
            return '%s_%s' % (remote, local)
        else:
            # local -> remote
            return '%s_%s' % (local, remote)

    def get_ipt_rules(self, host=None):
        # action
203
        action = 'LOG_ACC' if self.action == 'accept' else 'LOG_DROP'
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228

        # src and dst addresses
        src = None
        dst = None

        if host:
            ip = (host.ipv4, host.ipv6_with_prefixlen)
            if self.direction == 'in':
                dst = ip
            else:
                src = ip

        # src and dst ports
        if self.direction == 'in':
            dport = self.dport
            sport = self.sport
        else:
            dport = self.sport
            sport = self.dport

        # 'chain_name': rule dict
        retval = {}

        # process foreign vlans
        for foreign_vlan in self.foreign_network.vlans.all():
229
            r = IptRule(priority=self.weight, action=action,
230
                        proto=self.proto, extra=self.extra,
231
                        comment='Rule #%s' % self.pk,
232
                        src=src, dst=dst, dport=dport, sport=sport)
233 234 235 236 237 238 239 240 241 242 243 244 245 246
            # host, hostgroup or vlan rule
            if host or self.vlan_id:
                local_vlan = host.vlan.name if host else self.vlan.name
                chain_name = Rule.get_chain_name(local=local_vlan,
                                                 remote=foreign_vlan.name,
                                                 direction=self.direction)
            # firewall rule
            elif self.firewall_id:
                chain_name = 'INPUT' if self.direction == 'in' else 'OUTPUT'

            retval[chain_name] = r

        return retval

247 248 249 250 251 252 253 254
    class Meta:
        verbose_name = _("rule")
        verbose_name_plural = _("rules")
        ordering = (
            'direction',
            'proto',
            'sport',
            'dport',
255
            'nat_external_port',
256 257 258 259
            'host',
        )


260
class Vlan(AclBase, models.Model):
261 262 263 264 265 266 267 268 269 270 271 272

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

273 274 275 276
    ACL_LEVELS = (
        ('user', _('user')),
        ('operator', _('operator')),
    )
277
    CHOICES_NETWORK_TYPE = (('public', _('public')),
278
                            ('portforward', _('portforward')))
279 280 281 282 283 284 285 286 287 288
    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])
289 290 291 292 293
    network4 = IPNetworkField(unique=False,
                              version=4,
                              verbose_name=_('IPv4 address/prefix'),
                              help_text=_(
                                  'The IPv4 address and the prefix length '
294
                                  'of the gateway. '
295 296 297 298
                                  'Recommended value is the last '
                                  'valid address of the subnet, '
                                  'for example '
                                  '10.4.255.254/16 for 10.4.0.0/16.'))
299 300 301 302 303 304
    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)])
305 306 307 308 309 310 311 312
    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.'))
313
    snat_ip = models.GenericIPAddressField(protocol='ipv4', blank=True,
314 315 316 317 318 319 320 321
                                           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).'))
322
    snat_to = models.ManyToManyField('self', symmetrical=False, blank=True,
323 324 325 326 327 328 329
                                     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.'))
330 331
    network_type = models.CharField(choices=CHOICES_NETWORK_TYPE,
                                    verbose_name=_('network type'),
332
                                    default='portforward',
333
                                    max_length=20)
334
    managed = models.BooleanField(default=True, verbose_name=_('managed'))
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
    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")
356 357 358 359
    ipv6_template = models.TextField(
        validators=[val_ipv6_template],
        verbose_name=_('ipv6 template'),
        default="2001:738:2001:4031:%(b)d:%(c)d:%(d)d:0")
360 361 362 363 364 365 366 367 368 369 370 371 372
    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'))
373 374

    def __unicode__(self):
375 376
        return "%s - %s" % ("managed" if self.managed else "unmanaged",
                            self.name)
377

378 379 380 381
    @models.permalink
    def get_absolute_url(self):
        return ('network.vlan', None, {'vid': self.vid})

382 383 384 385 386 387
    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
388

389
    def get_new_address(self):
390
        hosts = self.host_set
391 392 393
        used_v4 = IPSet(hosts.values_list('ipv4', flat=True))
        used_v6 = IPSet(hosts.exclude(ipv6__isnull=True)
                        .values_list('ipv6', flat=True))
394

395 396 397 398 399 400 401 402 403 404
        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:
                ipv6 = convert_ipv4_to_ipv6(self.ipv6_template, ipv4)
                if ipv6 in used_v6:
                    continue
                else:
                    logger.debug("Found unused IPv6 address %s.", ipv6)
            return {'ipv4': ipv4, 'ipv6': ipv6}
405 406
        else:
            raise ValidationError(_("All IP addresses are already in use."))
407

408

409
class VlanGroup(models.Model):
410 411 412 413 414 415
    """
    A group of Vlans.
    """

    name = models.CharField(max_length=20, unique=True, verbose_name=_('name'),
                            help_text=_('The name of the group.'))
416
    vlans = models.ManyToManyField('Vlan', symmetrical=False, blank=True,
417 418 419 420 421 422 423 424 425 426 427
                                   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'))
428 429 430 431

    def __unicode__(self):
        return self.name

432 433 434 435 436
    @models.permalink
    def get_absolute_url(self):
        return ('network.vlan_group', None, {'pk': self.pk})


437
class Group(models.Model):
438 439 440 441 442 443 444 445 446 447 448 449 450
    """
    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'))
451 452 453 454

    def __unicode__(self):
        return self.name

455 456 457 458 459
    @models.permalink
    def get_absolute_url(self):
        return ('network.group', None, {'pk': self.pk})


460
class Host(models.Model):
461 462 463 464
    """
    A host of the network.
    """

465
    hostname = models.CharField(max_length=40,
466 467 468 469 470
                                verbose_name=_('hostname'),
                                help_text=_('The alphanumeric hostname of '
                                            'the host, the first part of '
                                            'the FQDN.'),
                                validators=[val_alfanum])
471
    normalized_hostname = HumanSortField(monitor='hostname', max_length=80)
472
    reverse = models.CharField(max_length=40, validators=[val_domain],
473 474 475 476 477 478 479 480 481
                               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.'))
482 483 484 485
    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.'))
486
    external_ipv4 = IPAddressField(
487
        version=4, blank=True, null=True,
488 489 490
        verbose_name=_('WAN IPv4 address'),
        help_text=_('The public IPv4 address of the host on the wide '
                    'area network, if different.'))
491 492 493 494 495
    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.'))
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
    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.'))
514
    groups = models.ManyToManyField('Group', symmetrical=False, blank=True,
515 516 517 518 519 520 521
                                    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'))
522

523 524
    class Meta(object):
        unique_together = ('hostname', 'vlan')
525
        ordering = ('normalized_hostname', 'vlan')
526

527 528 529
    def __unicode__(self):
        return self.hostname

530 531
    @property
    def incoming_rules(self):
532
        return self.rules.filter(direction='in')
533 534

    @property
535 536 537
    def ipv6_with_prefixlen(self):
        try:
            net = IPNetwork(self.ipv6)
538
            net.prefixlen = self.vlan.host_ipv6_prefixlen
539 540 541 542 543 544 545 546 547 548
            return net
        except TypeError:
            return None

    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'
549

550
    def clean(self):
551 552 553
        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)):
554
            raise ValidationError(_("If shared_ip has been checked, "
555 556
                                    "external_ipv4 has to be unique."))
        if Host.objects.exclude(id=self.id).filter(external_ipv4=self.ipv4):
557
            raise ValidationError(_("You can't use another host's NAT'd "
558
                                    "address as your own IPv4."))
559 560 561

    def save(self, *args, **kwargs):
        if not self.id and self.ipv6 == "auto":
562 563
            self.ipv6 = convert_ipv4_to_ipv6(self.vlan.ipv6_template,
                                             self.ipv4)
564
        self.full_clean()
565

566
        super(Host, self).save(*args, **kwargs)
567

Bach Dániel committed
568
        # IPv4
569
        if self.ipv4 is not None:
Bach Dániel committed
570 571 572 573 574 575
            # update existing records
            affected_records = Record.objects.filter(
                host=self, name=self.hostname,
                type='A').update(address=self.ipv4)
            # create new record
            if affected_records == 0:
576 577 578 579 580
                Record(host=self,
                       name=self.hostname,
                       domain=self.vlan.domain,
                       address=self.ipv4,
                       owner=self.owner,
Bach Dániel committed
581
                       description='created by host.save()',
582 583
                       type='A').save()

Bach Dániel committed
584 585 586 587 588 589 590 591
        # 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:
592 593 594 595 596
                Record(host=self,
                       name=self.hostname,
                       domain=self.vlan.domain,
                       address=self.ipv6,
                       owner=self.owner,
Bach Dániel committed
597
                       description='created by host.save()',
598
                       type='AAAA').save()
599 600

    def enable_net(self):
601 602
        for i in settings.get('default_host_groups', []):
            self.groups.add(Group.objects.get(name=i))
603

604 605 606 607
    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.
608

609 610 611 612
        :param proto: The transport protocol of the generated port (tcp|udp).
        :type proto: str.
        :returns: list -- list of int port numbers used.
        """
613 614 615 616 617
        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)
618
        else:
619 620 621
            ports = self.rules.filter(proto=proto).values_list(
                'dport', flat=True)
        return set(ports)
622 623 624 625 626 627 628 629

    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.
630
        :param used_ports: Optional set of used ports returned by
631 632 633 634 635 636 637 638 639 640 641 642 643
                           _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
644
            else:
645 646
                raise ValidationError(
                    _("All %s ports are already in use.") % proto)
647
        return public
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667

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

669 670 671 672 673 674
        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))
675
        else:
676
            rule = Rule(direction='in', owner=self.owner, dport=private,
677
                        proto=proto, nat=False, action='accept',
678 679
                        host=self, foreign_network=vg)
            if self.behind_nat:
680 681 682
                if public < 1024:
                    raise ValidationError(
                        _("Only ports above 1024 can be used."))
683 684
                rule.nat_external_port = public
                rule.nat = True
685 686
            rule.full_clean()
            rule.save()
687 688

    def del_port(self, proto, private):
689 690 691 692 693 694 695 696 697 698
        """
        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.
        """

699
        self.rules.filter(proto=proto, dport=private).delete()
700

701
    def get_hostname(self, proto, public=True):
702
        """
703
        Get a private or public hostname for host.
704 705 706 707 708

        :param proto: The IP version (ipv4|ipv6).
        :type proto: str.
        """
        assert proto in ('ipv6', 'ipv4', )
709 710
        try:
            if proto == 'ipv6':
711 712
                res = self.record_set.filter(type='AAAA',
                                             address=self.ipv6)
713
            elif proto == 'ipv4':
714 715 716
                if self.behind_nat and public:
                    res = Record.objects.filter(
                        type='A', address=self.get_external_ipv4())
717
                    if res.count() < 1:
718
                        return unicode(self.get_external_ipv4())
719
                else:
720 721 722
                    res = self.record_set.filter(type='A',
                                                 address=self.ipv4)
            return unicode(res[0].fqdn)
723
        except:
724
            return None
725 726

    def list_ports(self):
727 728 729
        """
        Return a list of ports with forwarding rules set.
        """
730
        retval = []
731
        for rule in self.rules.all():
732 733
            forward = {
                'proto': rule.proto,
734
                'private': rule.dport,
735 736 737 738 739
            }

            if True:      # ipv4
                forward['ipv4'] = {
                    'host': self.get_hostname(proto='ipv4'),
740
                    'port': rule.get_external_port(proto='ipv4'),
741
                    'pk': rule.pk,
742
                }
743
            if self.ipv6:  # ipv6
744 745
                forward['ipv6'] = {
                    'host': self.get_hostname(proto='ipv6'),
746
                    'port': rule.get_external_port(proto='ipv6'),
747
                    'pk': rule.pk,
748 749 750 751 752
                }
            retval.append(forward)
        return retval

    def get_fqdn(self):
753 754 755
        """
        Get fully qualified host name of host.
        """
756
        return self.get_hostname('ipv4', public=False)
757

758 759 760 761 762 763 764
    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
765
        ports = self.incoming_rules.filter(action='accept', dport=port,
766 767 768 769 770
                                           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
771 772
                             None)
        # IPv6
773
        endpoints['ipv6'] = (self.ipv6, port) if public_port else None
774 775
        return endpoints

776 777 778 779
    @models.permalink
    def get_absolute_url(self):
        return ('network.host', None, {'pk': self.pk})

780 781 782 783 784 785 786 787 788 789 790
    @property
    def eui(self):
        return EUI(self.mac)

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

791 792

class Firewall(models.Model):
793 794
    name = models.CharField(max_length=20, unique=True,
                            verbose_name=_('name'))
795 796 797 798

    def __unicode__(self):
        return self.name

799

800
class Domain(models.Model):
801 802 803 804 805 806 807 808 809
    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'))
810 811 812 813

    def __unicode__(self):
        return self.name

814 815 816 817 818
    @models.permalink
    def get_absolute_url(self):
        return ('network.domain', None, {'pk': self.pk})


819 820
class Record(models.Model):
    CHOICES_type = (('A', 'A'), ('CNAME', 'CNAME'), ('AAAA', 'AAAA'),
Bach Dániel committed
821
                    ('MX', 'MX'), ('NS', 'NS'), ('PTR', 'PTR'), ('TXT', 'TXT'))
822
    name = models.CharField(max_length=40, validators=[val_domain_wildcard],
823 824 825 826 827 828
                            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'))
829
    address = models.CharField(max_length=200,
830 831 832 833 834 835 836 837
                               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'))
838 839 840 841 842

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

    def desc(self):
843
        return u' '.join([self.fqdn, self.type, self.address])
844 845 846 847 848

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

849 850
    def _validate_record(self):
        """Validate a record."""
851 852
        if not self.address:
            raise ValidationError(_("Address must be specified!"))
853 854 855 856 857 858 859 860 861 862 863 864

        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:
865
            raise ValidationError(_("Unknown record type."))
866 867 868
        else:
            if validator:
                validator(self.address)
869

870
    def clean(self):
871 872
        """Validate the Record to be saved.
        """
873 874 875
        if self.name:
            self.name = self.name.rstrip(".")    # remove trailing dots

876
        self._validate_record()
877

878 879
    @property
    def fqdn(self):
880 881 882 883
        if self.name:
            return '%s.%s' % (self.name, self.domain.name)
        else:
            return self.domain.name
884

885 886 887 888
    @models.permalink
    def get_absolute_url(self):
        return ('network.record', None, {'pk': self.pk})

889 890 891 892 893 894
    class Meta:
        ordering = (
            'domain',
            'name',
        )

895

896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
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)

917 918 919 920
    @models.permalink
    def get_absolute_url(self):
        return ('network.switch_port', None, {'pk': self.pk})

921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940

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


941
class BlacklistItem(models.Model):
942 943
    CHOICES_type = (('permban', 'permanent ban'), ('tempban', 'temporary ban'),
                    ('whitelist', 'whitelist'), ('tempwhite', 'tempwhite'))
944
    ipv4 = models.GenericIPAddressField(protocol='ipv4', unique=True)
945 946 947 948 949 950 951 952 953 954 955 956 957 958 959
    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'))
960 961 962

    def save(self, *args, **kwargs):
        self.full_clean()
963
        super(BlacklistItem, self).save(*args, **kwargs)
964

965 966 967
    def __unicode__(self):
        return self.ipv4

968 969 970 971
    class Meta(object):
        verbose_name = _('blacklist item')
        verbose_name_plural = _('blacklist')

972 973 974 975 976
    @models.permalink
    def get_absolute_url(self):
        return ('network.blacklist', None, {'pk': self.pk})


977
def send_task(sender, instance, created=False, **kwargs):
978
    reloadtask.apply_async(queue='localhost.man', args=[sender.__name__])
979 980


981 982
for sender in [Host, Rule, Domain, Record, Vlan, Firewall, Group,
               BlacklistItem, SwitchPort, EthernetDevice]:
983 984
    post_save.connect(send_task, sender=sender)
    post_delete.connect(send_task, sender=sender)