Files
@ 3d9170ce641a
Branch filter:
Location: conntrackt/conntrackt/models.py
3d9170ce641a
7.6 KiB
text/x-python
Added documentation, removed unused admin action.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 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 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 | # Basic classes needed for creating models.
from django.db import models
#
from django.core.exceptions import ValidationError
# Create your models here.
class Project(models.Model):
"""
Implements a model with information about a project. A project has some
basic settings, and mainly serves the purpose of grouping entities for
easier handling and administration.
Fields:
name - String denoting the project name.
description - Free-form description of the project.
"""
name = models.CharField(max_length = 100)
description = models.TextField(blank = True)
def __unicode__(self):
"""
Returns:
String representation of a project.
"""
return self.name
class Location(models.Model):
"""
Implements a model with information about location. Locations can further be
assigned to entities, letting the user group different servers and equipment
based on location.
Locations are not tied to specific project, and they do not have to be
actual physical locations. Such generic locations are therefore reusable
accross multiple projects.
For example, locations can be:
- Main site
- Backup site
- Disaster recovery site
- Belgrade
- Stockholm
Fields:
name - String denoting the location name.
description - Free-form description of a location.
"""
name = models.CharField(max_length = 100)
description = models.TextField(blank = True)
def __unicode__(self):
"""
Returns:
String representation of a location.
"""
return self.name
class Entity(models.Model):
"""
Models an entity in a project. An entity can be a server, router, or any
other piece of networking equipment that has its own IP address.
Entities can also be used for representing subnets etc. This is useful when
the communication restrictions need to be applied across a subnet.
Entities are tied to specific projects and locations.
Fields:
name - String denoting the entity name.
description - Free-form description of an entity.
project - Foreign key pointing to the project to which the entity
belongs.
location - Foreign key pointing to the location at which the entity is
located.
"""
name = models.CharField(max_length = 100)
description = models.TextField(blank = True)
project = models.ForeignKey(Project)
location = models.ForeignKey(Location)
class Meta:
"""
Overrides some of the default parameters used by Django for this model.
Properties:
verbose_name_plural - Changes the way Django Admin displays the model
name in plural.
"""
verbose_name_plural = 'entities'
def __unicode__(self):
"""
Returns:
String representation of an entity. This identifier contains name of
entity, its project name, and location name.
"""
return "%s (%s - %s)" % (self.name, self.project, self.location)
class Interface(models.Model):
"""
Models a representation of an interface on an entity. It can be used for
representing the subnets as well.
Each interface is coupled with a specific Entity.
Fields:
name - String denoting the interface name. For example 'eth0', 'eth1'
etc.
description - Free-form description of an interface.
entity - Foreign key pointing to the entity to which the interface
belongs.
address - IP address of an interface. It's possible to store network
address in it as well.
netmask - Netmask of the interface. By default this is /32
(255.255.255.255), but in case of subnet entities this can be used for
denoting the network netmask.
"""
name = models.CharField(max_length = 100, default = 'eth0')
description = models.TextField(blank = True, default = 'Main network interface.')
entity = models.ForeignKey(Entity)
address = models.IPAddressField()
netmask = models.IPAddressField(default = '255.255.255.255')
def __unicode__(self):
"""
Returns:
String representation of an interface. In case of single IP this will
simply be the interface name and IP address. In case of subnet it will
include the netmask as well.
"""
if self.netmask == '255.255.255.255':
return '%s (%s)' % (self.entity.name, self.address)
else:
return '%s (%s/%s)' % (self.entity.name, self.address, self.netmask)
class Communication(models.Model):
"""
Models a representation of allowed network communication. This lets the user
display the possible network connections that should be allowed. Information
from the communication instances is also used for generating the iptables
rules for the entities.
Communication instances allow the user to specify one of the three possible
protocols and related information:
- TCP, along with the TCP port.
- UDP, along with the UDP port.
- ICMP, along with the ICMP type.
Allowed communication is always represented as combination of source
interface, destination interface, protocol, and port/ICMP type.
Fields:
source - Foreign key to the source (originating) interface. The
communication is expected to come _from_ the source.
destination - Foreign key to the destination interface. The destination
interface is expected to be able to accept incoming connections
(i.e. entity's servers are listening on those).
protocol - Textual field denoting the protocol that is used for
communication. This can be 'TCP', 'UDP', or 'ICMP'.
port - Port number used by the protocol. In case of ICMP, this is an ICMP
type (in numeric form).
description - Free-form text that can be used to describe the
communication. This is also used when generating the iptables rules for
documenting the rules.
"""
PROTOCOL_CHOICES = (
('TCP', 'TCP'),
('UDP', 'UDP'),
('ICMP', 'ICMP'),
)
source = models.ForeignKey(Interface, related_name = 'source_set')
destination = models.ForeignKey(Interface, related_name = 'destination_set')
protocol = models.CharField(max_length = 10, choices = PROTOCOL_CHOICES)
port = models.IntegerField(default = 0)
description = models.TextField(blank = True)
def __unicode__(self):
"""
Returns:
String representation of an interface. This involves showing the
source and destination _entity_ name, protocol, and port.
"""
return "%s -> %s (%s:%s)" % (self.source.entity.name, self.destination.entity.name, self.protocol, self.port)
def clean(self):
"""
Performs additional validation checks on the submitted data. It will
verify the following:
- That source and destination interface belongs to distinct entities.
- That the specified protocol is supported.
"""
if self.source.entity == self.destination.entity:
raise ValidationError('Source and destination entities must differ.')
if (self.protocol.upper(), self.protocol.upper()) not in self.PROTOCOL_CHOICES:
raise ValidationError('%s is not a supported protocol.' % self.protocol)
def edit_link(self):
"""
This method is used for providing an additional 'Edit' link in the admin
site for the communication instances (for the display_list).
This provides ability to let all of the other fields of a communication
instance to be editable.
"""
return "Edit"
|