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

3
from itertools import islice, ifilter
4
import logging
5
from netaddr import IPSet, EUI, IPNetwork
6

7 8
from django.contrib.auth.models import User
from django.db import models
9
from django.forms import ValidationError
10
from django.utils.translation import ugettext_lazy as _
11
from firewall.fields import (MACAddressField, val_alfanum, val_reverse_domain,
12 13 14
                             val_ipv6_template, val_domain, val_ipv4,
                             val_ipv6, val_mx, convert_ipv4_to_ipv6,
                             IPNetworkField, IPAddressField)
15 16
from django.core.validators import MinValueValidator, MaxValueValidator
import django.conf
17
from django.db.models.signals import post_save, post_delete
18 19
import random

20
from common.models import HumanSortField
Bach Dániel committed
21
from firewall.tasks.local_tasks import reloadtask
22
from .iptables import IptRule
23
from acl.models import AclBase
24
logger = logging.getLogger(__name__)
25
settings = django.conf.settings.FIREWALL_SETTINGS
26 27


28 29
class Rule(models.Model):

30 31 32
    """
    A rule of a packet filter, changing the behavior of a host, vlan or
    firewall.
33

34 35
    Some rules accept or deny packets matching some criteria.
    Others set address translation or other free-form iptables parameters.
36 37
    """
    CHOICES_type = (('host', 'host'), ('firewall', 'firewall'),
38
                   ('vlan', 'vlan'))
39
    CHOICES_proto = (('tcp', 'tcp'), ('udp', 'udp'), ('icmp', 'icmp'))
40 41 42
    CHOICES_dir = (('out', _('out')), ('in', _('in')))
    CHOICES_action = (('accept', _('accept')), ('drop', _('drop')),
                      ('ignore', _('ignore')))
43

44
    direction = models.CharField(max_length=3, choices=CHOICES_dir,
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
                                 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."))
64 65
    weight = models.IntegerField(
        verbose_name=_("weight"),
66
        validators=[MinValueValidator(1), MaxValueValidator(65535)],
67 68
        help_text=_("Rule weight"),
        default=30000)
69
    proto = models.CharField(max_length=10, choices=CHOICES_proto,
70 71 72 73 74
                             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."))
75 76 77 78
    action = models.CharField(max_length=10, choices=CHOICES_action,
                              default='drop', verbose_name=_('action'),
                              help_text=_("Accept, drop or ignore the "
                                          "matching packets."))
79 80 81 82
    owner = models.ForeignKey(User, blank=True, null=True,
                              verbose_name=_("owner"),
                              help_text=_("The user responsible for "
                                          "this rule."))
83

84 85
    nat = models.BooleanField(default=False, verbose_name=_("NAT"),
                              help_text=_("If network address translation "
86
                                          "should be done."))
87 88 89 90 91 92 93 94 95
    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'))

96 97 98 99 100 101
    created_at = models.DateTimeField(
        auto_now_add=True,
        verbose_name=_("created at"))
    modified_at = models.DateTimeField(
        auto_now=True,
        verbose_name=_("modified at"))
102 103

    vlan = models.ForeignKey('Vlan', related_name="rules", blank=True,
104 105 106
                             null=True, verbose_name=_("vlan"),
                             help_text=_("Vlan the rule applies to "
                                         "(if type is vlan)."))
107
    vlangroup = models.ForeignKey('VlanGroup', related_name="rules",
108 109 110 111
                                  blank=True, null=True, verbose_name=_(
                                      "vlan group"),
                                  help_text=_("Group of vlans the rule "
                                              "applies to (if type is vlan)."))
112
    host = models.ForeignKey('Host', related_name="rules", blank=True,
113 114 115 116 117 118 119 120 121 122 123 124
                             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)
125 126 127 128 129 130

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

    def clean(self):
        fields = [self.vlan, self.vlangroup, self.host, self.hostgroup,
131
                  self.firewall]
132 133 134 135
        selected_fields = [field for field in fields if field]
        if len(selected_fields) > 1:
            raise ValidationError(_('Only one field can be selected.'))

136 137 138 139 140 141 142 143 144 145 146
    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

147
    def desc(self):
148 149
        """Return a short string representation of the current rule.
        """
150 151
        return u'[%(type)s] %(src)s ▸ %(dst)s %(para)s %(desc)s' % {
            'type': self.r_type,
152
            'src': (unicode(self.foreign_network) if self.direction == 'in'
153
                    else self.r_type),
154
            'dst': (self.r_type if self.direction == 'out'
155
                    else unicode(self.foreign_network)),
156 157 158 159 160
            '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}

161 162 163 164 165 166 167 168 169
    @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

170 171 172 173
    @models.permalink
    def get_absolute_url(self):
        return ('network.rule', None, {'pk': self.pk})

174 175 176 177 178 179 180 181 182 183 184
    @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
185
        action = 'LOG_ACC' if self.action == 'accept' else 'LOG_DROP'
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210

        # 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():
211
            r = IptRule(priority=self.weight, action=action,
212
                        proto=self.proto, extra=self.extra,
213
                        comment='Rule #%s' % self.pk,
214
                        src=src, dst=dst, dport=dport, sport=sport)
215 216 217 218 219 220 221 222 223 224 225 226 227 228
            # 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

229 230 231 232 233 234 235 236
    class Meta:
        verbose_name = _("rule")
        verbose_name_plural = _("rules")
        ordering = (
            'direction',
            'proto',
            'sport',
            'dport',
237
            'nat_external_port',
238 239 240 241
            'host',
        )


242
class Vlan(AclBase, models.Model):
243 244 245 246 247 248 249 250 251 252 253 254

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

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

    def __unicode__(self):
357 358
        return "%s - %s" % ("managed" if self.managed else "unmanaged",
                            self.name)
359

360 361 362 363
    @models.permalink
    def get_absolute_url(self):
        return ('network.vlan', None, {'vid': self.vid})

364 365 366 367 368 369
    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
370

371
    def get_new_address(self):
372
        hosts = self.host_set
373 374 375
        used_v4 = IPSet(hosts.values_list('ipv4', flat=True))
        used_v6 = IPSet(hosts.exclude(ipv6__isnull=True)
                        .values_list('ipv6', flat=True))
376

377 378 379 380 381 382 383 384 385 386
        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}
387 388
        else:
            raise ValidationError(_("All IP addresses are already in use."))
389

390

391
class VlanGroup(models.Model):
392 393 394 395 396 397
    """
    A group of Vlans.
    """

    name = models.CharField(max_length=20, unique=True, verbose_name=_('name'),
                            help_text=_('The name of the group.'))
398
    vlans = models.ManyToManyField('Vlan', symmetrical=False, blank=True,
399 400 401 402 403 404 405 406 407 408 409
                                   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'))
410 411 412 413

    def __unicode__(self):
        return self.name

414 415 416 417 418
    @models.permalink
    def get_absolute_url(self):
        return ('network.vlan_group', None, {'pk': self.pk})


419
class Group(models.Model):
420 421 422 423 424 425 426 427 428 429 430 431 432
    """
    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'))
433 434 435 436

    def __unicode__(self):
        return self.name

437 438 439 440 441
    @models.permalink
    def get_absolute_url(self):
        return ('network.group', None, {'pk': self.pk})


442
class Host(models.Model):
443 444 445 446
    """
    A host of the network.
    """

447
    hostname = models.CharField(max_length=40,
448 449 450 451 452
                                verbose_name=_('hostname'),
                                help_text=_('The alphanumeric hostname of '
                                            'the host, the first part of '
                                            'the FQDN.'),
                                validators=[val_alfanum])
453
    normalized_hostname = HumanSortField(monitor='hostname', max_length=80)
454
    reverse = models.CharField(max_length=40, validators=[val_domain],
455 456 457 458 459 460 461 462 463
                               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.'))
464 465 466 467
    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.'))
468
    external_ipv4 = IPAddressField(
469
        version=4, blank=True, null=True,
470 471 472
        verbose_name=_('WAN IPv4 address'),
        help_text=_('The public IPv4 address of the host on the wide '
                    'area network, if different.'))
473 474 475 476 477
    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.'))
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
    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.'))
496
    groups = models.ManyToManyField('Group', symmetrical=False, blank=True,
497 498 499 500 501 502 503
                                    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'))
504

505 506
    class Meta(object):
        unique_together = ('hostname', 'vlan')
507
        ordering = ('normalized_hostname', 'vlan')
508

509 510 511
    def __unicode__(self):
        return self.hostname

512 513
    @property
    def incoming_rules(self):
514
        return self.rules.filter(direction='in')
515 516

    @property
517 518 519
    def ipv6_with_prefixlen(self):
        try:
            net = IPNetwork(self.ipv6)
520
            net.prefixlen = self.vlan.host_ipv6_prefixlen
521 522 523 524 525 526 527 528 529 530
            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'
531

532
    def clean(self):
533 534 535
        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)):
536
            raise ValidationError(_("If shared_ip has been checked, "
537 538
                                    "external_ipv4 has to be unique."))
        if Host.objects.exclude(id=self.id).filter(external_ipv4=self.ipv4):
539
            raise ValidationError(_("You can't use another host's NAT'd "
540
                                    "address as your own IPv4."))
541 542 543

    def save(self, *args, **kwargs):
        if not self.id and self.ipv6 == "auto":
544 545
            self.ipv6 = convert_ipv4_to_ipv6(self.vlan.ipv6_template,
                                             self.ipv4)
546
        self.full_clean()
547

548
        super(Host, self).save(*args, **kwargs)
549

Bach Dániel committed
550
        # IPv4
551
        if self.ipv4 is not None:
Bach Dániel committed
552 553 554 555 556 557
            # 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:
558 559 560 561 562
                Record(host=self,
                       name=self.hostname,
                       domain=self.vlan.domain,
                       address=self.ipv4,
                       owner=self.owner,
Bach Dániel committed
563
                       description='created by host.save()',
564 565
                       type='A').save()

Bach Dániel committed
566 567 568 569 570 571 572 573
        # 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:
574 575 576 577 578
                Record(host=self,
                       name=self.hostname,
                       domain=self.vlan.domain,
                       address=self.ipv6,
                       owner=self.owner,
Bach Dániel committed
579
                       description='created by host.save()',
580
                       type='AAAA').save()
581 582

    def enable_net(self):
583 584
        for i in settings.get('default_host_groups', []):
            self.groups.add(Group.objects.get(name=i))
585

586 587 588 589
    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.
590

591 592 593 594
        :param proto: The transport protocol of the generated port (tcp|udp).
        :type proto: str.
        :returns: list -- list of int port numbers used.
        """
595 596 597 598 599
        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)
600
        else:
601 602 603
            ports = self.rules.filter(proto=proto).values_list(
                'dport', flat=True)
        return set(ports)
604 605 606 607 608 609 610 611

    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.
612
        :param used_ports: Optional set of used ports returned by
613 614 615 616 617 618 619 620 621 622 623 624 625
                           _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
626
            else:
627 628
                raise ValidationError(
                    _("All %s ports are already in use.") % proto)
629
        return public
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649

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

651 652 653 654 655 656
        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))
657
        else:
658
            rule = Rule(direction='in', owner=self.owner, dport=private,
659
                        proto=proto, nat=False, action='accept',
660 661
                        host=self, foreign_network=vg)
            if self.behind_nat:
662 663 664
                if public < 1024:
                    raise ValidationError(
                        _("Only ports above 1024 can be used."))
665 666
                rule.nat_external_port = public
                rule.nat = True
667 668
            rule.full_clean()
            rule.save()
669 670

    def del_port(self, proto, private):
671 672 673 674 675 676 677 678 679 680
        """
        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.
        """

681 682
        self.rules.filter(owner=self.owner, proto=proto, host=self,
                          dport=private).delete()
683

684
    def get_hostname(self, proto, public=True):
685
        """
686
        Get a private or public hostname for host.
687 688 689 690 691

        :param proto: The IP version (ipv4|ipv6).
        :type proto: str.
        """
        assert proto in ('ipv6', 'ipv4', )
692 693
        try:
            if proto == 'ipv6':
694 695
                res = self.record_set.filter(type='AAAA',
                                             address=self.ipv6)
696
            elif proto == 'ipv4':
697 698 699
                if self.behind_nat and public:
                    res = Record.objects.filter(
                        type='A', address=self.get_external_ipv4())
700
                    if res.count() < 1:
701
                        return unicode(self.get_external_ipv4())
702
                else:
703 704 705
                    res = self.record_set.filter(type='A',
                                                 address=self.ipv4)
            return unicode(res[0].fqdn)
706
        except:
707
            return None
708 709

    def list_ports(self):
710 711 712
        """
        Return a list of ports with forwarding rules set.
        """
713 714 715 716
        retval = []
        for rule in self.rules.filter(owner=self.owner):
            forward = {
                'proto': rule.proto,
717
                'private': rule.dport,
718 719 720 721 722
            }

            if True:      # ipv4
                forward['ipv4'] = {
                    'host': self.get_hostname(proto='ipv4'),
723
                    'port': rule.get_external_port(proto='ipv4'),
724
                    'pk': rule.pk,
725
                }
726
            if self.ipv6:  # ipv6
727 728
                forward['ipv6'] = {
                    'host': self.get_hostname(proto='ipv6'),
729
                    'port': rule.get_external_port(proto='ipv6'),
730
                    'pk': rule.pk,
731 732 733 734 735
                }
            retval.append(forward)
        return retval

    def get_fqdn(self):
736 737 738
        """
        Get fully qualified host name of host.
        """
739
        return self.get_hostname('ipv4', public=False)
740

741 742 743 744 745 746 747
    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
748
        ports = self.incoming_rules.filter(action='accept', dport=port,
749 750 751 752 753
                                           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
754 755
                             None)
        # IPv6
756 757
        blocked = self.incoming_rules.exclude(
            action='accept').filter(dport=port, proto=protocol).exists()
758 759 760
        endpoints['ipv6'] = (self.ipv6, port) if not blocked else None
        return endpoints

761 762 763 764
    @models.permalink
    def get_absolute_url(self):
        return ('network.host', None, {'pk': self.pk})

765 766 767 768 769 770 771 772 773 774 775
    @property
    def eui(self):
        return EUI(self.mac)

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

776 777

class Firewall(models.Model):
778 779
    name = models.CharField(max_length=20, unique=True,
                            verbose_name=_('name'))
780 781 782 783

    def __unicode__(self):
        return self.name

784

785
class Domain(models.Model):
786 787 788 789 790 791 792 793 794
    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'))
795 796 797 798

    def __unicode__(self):
        return self.name

799 800 801 802 803
    @models.permalink
    def get_absolute_url(self):
        return ('network.domain', None, {'pk': self.pk})


804 805
class Record(models.Model):
    CHOICES_type = (('A', 'A'), ('CNAME', 'CNAME'), ('AAAA', 'AAAA'),
806
                   ('MX', 'MX'), ('NS', 'NS'), ('PTR', 'PTR'), ('TXT', 'TXT'))
807
    name = models.CharField(max_length=40, validators=[val_domain],
808 809 810 811 812 813
                            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'))
814
    address = models.CharField(max_length=200,
815 816 817 818 819 820 821 822
                               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'))
823 824 825 826 827

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

    def desc(self):
828
        return u' '.join([self.fqdn, self.type, self.address])
829 830 831 832 833

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

834 835
    def _validate_record(self):
        """Validate a record."""
836 837
        if not self.address:
            raise ValidationError(_("Address must be specified!"))
838 839 840 841 842 843 844 845 846 847 848 849

        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:
850
            raise ValidationError(_("Unknown record type."))
851 852 853
        else:
            if validator:
                validator(self.address)
854

855
    def clean(self):
856 857
        """Validate the Record to be saved.
        """
858 859 860
        if self.name:
            self.name = self.name.rstrip(".")    # remove trailing dots

861
        self._validate_record()
862

863 864
    @property
    def fqdn(self):
865 866 867 868
        if self.name:
            return '%s.%s' % (self.name, self.domain.name)
        else:
            return self.domain.name
869

870 871 872 873
    @models.permalink
    def get_absolute_url(self):
        return ('network.record', None, {'pk': self.pk})

874 875 876 877 878 879
    class Meta:
        ordering = (
            'domain',
            'name',
        )

880

881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901
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)

902 903 904 905
    @models.permalink
    def get_absolute_url(self):
        return ('network.switch_port', None, {'pk': self.pk})

906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925

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


926
class BlacklistItem(models.Model):
927 928
    CHOICES_type = (('permban', 'permanent ban'), ('tempban', 'temporary ban'),
                    ('whitelist', 'whitelist'), ('tempwhite', 'tempwhite'))
929
    ipv4 = models.GenericIPAddressField(protocol='ipv4', unique=True)
930 931 932 933 934 935 936 937 938 939 940 941 942 943 944
    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'))
945 946 947

    def save(self, *args, **kwargs):
        self.full_clean()
948
        super(BlacklistItem, self).save(*args, **kwargs)
949

950 951 952
    def __unicode__(self):
        return self.ipv4

953 954 955 956
    class Meta(object):
        verbose_name = _('blacklist item')
        verbose_name_plural = _('blacklist')

957 958 959 960 961
    @models.permalink
    def get_absolute_url(self):
        return ('network.blacklist', None, {'pk': self.pk})


962
def send_task(sender, instance, created=False, **kwargs):
963
    reloadtask.apply_async(queue='localhost.man', args=[sender.__name__])
964 965


966 967
for sender in [Host, Rule, Domain, Record, Vlan, Firewall, Group,
               BlacklistItem, SwitchPort, EthernetDevice]:
968 969
    post_save.connect(send_task, sender=sender)
    post_delete.connect(send_task, sender=sender)