subnets.py 11 KB
Newer Older
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
# Copyright 2013 GRNET S.A. All rights reserved.
#
# Redistribution and use in source and binary forms, with or
# without modification, are permitted provided that the following
# conditions are met:
#
#   1. Redistributions of source code must retain the above
#      copyright notice, this list of conditions and the following
#      disclaimer.
#
#   2. Redistributions in binary form must reproduce the above
#      copyright notice, this list of conditions and the following
#      disclaimer in the documentation and/or other materials
#      provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# The views and conclusions contained in the software and
# documentation are those of the authors and should not be
# interpreted as representing official policies, either expressed
# or implied, of GRNET S.A.

34
import ipaddr
35
from logging import getLogger
36
37
38
39
from functools import wraps

from django.conf import settings
from django.db import transaction
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
from snf_django.lib import api
from snf_django.lib.api import faults

from synnefo.db.models import Subnet, Network, IPPoolTable

log = getLogger(__name__)


def subnet_command(action):
    def decorator(func):
        @wraps(func)
        @transaction.commit_on_success()
        def wrapper(subnet, *args, **kwargs):
            return func(subnet, *args, **kwargs)
        return wrapper
    return decorator


def list_subnets(user_id):
    """List all subnets of a user"""
    log.debug('list_subnets')

    user_subnets = Subnet.objects.filter(network__userid=user_id)
63
    return user_subnets
64
65
66


@transaction.commit_on_success
67
68
69
70
71
72
73
def create_subnet(*args, **kwargs):
    return _create_subnet(*args, **kwargs)


def _create_subnet(network_id, user_id, cidr, name, ipversion=4, gateway=None,
                   dhcp=True, slac=True, dns_nameservers=None,
                   allocation_pools=None, host_routes=None):
74
    """Create a subnet
75

76
    network_id and the desired cidr are mandatory, everything else is optional
77

78
79
80
81
82
83
    """
    try:
        network = Network.objects.get(id=network_id)
    except Network.DoesNotExist:
        raise api.faults.ItemNotFound("No networks found with that id")

84
85
86
    if user_id != network.userid:
        raise api.faults.Unauthorized("Unauthorized operation")

87
88
89
    if ipversion not in [4, 6]:
        raise api.faults.BadRequest("Malformed IP version type")

90
91
    check_number_of_subnets(network, ipversion)

92
    # Returns the first available IP in the subnet
93
    try:
94
        cidr_ip = ipaddr.IPNetwork(cidr)
95
96
    except ValueError:
        raise api.faults.BadRequest("Malformed CIDR")
97
    potential_gateway = str(ipaddr.IPNetwork(cidr).network + 1)
98

99
    if gateway is "":
100
101
        gateway = potential_gateway

102
    if ipversion == 6:
103
        validate_subnet_params(None, None, cidr, gateway)
104
105
106
107
108
        if slac is not None:
            dhcp = check_boolean_value(slac, "enable_slac")
        else:
            dhcp = check_boolean_value(dhcp, "dhcp")
    else:
109
        validate_subnet_params(cidr, gateway)
110
111
112
113
        dhcp = check_boolean_value(dhcp, "dhcp")

    name = check_name_length(name)

114
    gateway_ip = ipaddr.IPAddress(gateway)
115
116
117

    sub = Subnet.objects.create(name=name, network=network, cidr=cidr,
                                ipversion=ipversion, gateway=gateway,
118
119
                                dhcp=dhcp, host_routes=host_routes,
                                dns_nameservers=dns_nameservers)
120
121
122
123
124

    if allocation_pools is not None:
        # If the user specified IP allocation pools, validate them and use them
        if ipversion == 6:
            raise api.faults.Conflict("Can't allocate an IP Pool in IPv6")
125
        validate_subpools(allocation_pools, cidr_ip, gateway_ip)
126
127
128
129
    if allocation_pools is None and ipversion == 4:
        # Check if the gateway is the first IP of the subnet, in this case
        # create a single ip pool
        if int(gateway_ip) - int(cidr_ip) == 1:
130
            allocation_pools = [[gateway_ip + 1, cidr_ip.broadcast - 1]]
131
132
133
        else:
            # If the gateway isn't the first available ip, create two different
            # ip pools adjacent to said ip
134
135
            allocation_pools = (([cidr_ip.network + 1, gateway_ip - 1]),
                                ([gateway_ip + 1, cidr_ip.broadcast - 1]))
136

137
138
    if allocation_pools:
        create_ip_pools(allocation_pools, cidr_ip, sub)
139
140
141
142
143
144
145
146
147
148
149
150

    return sub


def get_subnet(sub_id):
    """Show info of a specific subnet"""
    log.debug('get_subnet %s', sub_id)
    try:
        subnet = Subnet.objects.get(id=sub_id)
    except Subnet.DoesNotExist:
        raise api.faults.ItemNotFound("Subnet not found")

151
    return subnet
152
153
154


def delete_subnet():
155
    """Delete a subnet, raises BadRequest
156
    A subnet is deleted ONLY when the network that it belongs to is deleted
157

158
159
160
161
162
    """
    raise api.faults.BadRequest("Deletion of a subnet is not supported")


@transaction.commit_on_success
163
def update_subnet(sub_id, name, user_id):
164
    """Update the fields of a subnet
165
    Only the name can be updated
166

167
    """
168
    log.info('Update subnet %s, name %s' % (sub_id, name))
169
170
171
172
173
174

    try:
        subnet = Subnet.objects.get(id=sub_id)
    except:
        raise api.faults.ItemNotFound("Subnet not found")

175
176
177
    if user_id != subnet.network.userid:
        raise api.faults.Unauthorized("Unauthorized operation")

178
179
180
181
182
183
184
185
186
187
188
    check_name_length(name)

    subnet.name = name
    subnet.save()

    return subnet


#Utility functions
def create_ip_pools(pools, cidr, subnet):
    """Create IP Pools in the database"""
189
    ip_pools = []
190
191
192
193
194
195
    for pool in pools:
        size = int(pool[1]) - int(pool[0]) + 1
        base = str(cidr)
        offset = int(pool[0]) - int(cidr.network)
        ip_pool = IPPoolTable.objects.create(size=size, offset=offset,
                                             base=base, subnet=subnet)
196
197
        ip_pools.append(ip_pool)
    return ip_pools
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
228
229


def check_empty_lists(value):
    """Check if value is Null/None, in which case we return an empty list"""
    if value is None:
        return []
    return value


def check_number_of_subnets(network, version):
    """Check if a user can add a subnet in a network"""
    if network.subnets.filter(ipversion=version):
        raise api.faults.BadRequest("Only one subnet of IPv4/IPv6 per "
                                    "network is allowed")


def check_boolean_value(value, key):
    """Check if dhcp value is in acceptable values"""
    if value not in [True, False]:
        raise api.faults.BadRequest("Malformed request, %s must "
                                    "be True or False" % key)
    return value


def check_name_length(name):
    """Check if the length of a name is within acceptable value"""
    if len(str(name)) > Subnet.SUBNET_NAME_LENGTH:
        raise api.faults.BadRequest("Subnet name too long")
    return name


def get_subnet_fromdb(subnet_id, user_id, for_update=False):
230
    """Return a Subnet instance or raise ItemNotFound.
231
    This is the same as util.get_network
232

233
234
235
236
237
238
239
240
241
242
243
244
245
    """
    try:
        subnet_id = int(subnet_id)
        if for_update:
            return Subnet.objects.select_for_update().get(id=subnet_id,
                                                          network__userid=
                                                          user_id)
        return Subnet.objects.get(id=subnet_id, network__userid=user_id)
    except (ValueError, Subnet.DoesNotExist):
        raise api.faults.ItemNotFound('Subnet not found')


def validate_subpools(pool_list, cidr, gateway):
246
247
    """Validate IP Pools

248
249
250
251
252
253
254
    Validate the given IP pools are inside the cidr range
    Validate there are no overlaps in the given pools
    Finally, validate the gateway isn't in the given ip pools
    Input must be a list containing a sublist with start/end ranges as
    ipaddr.IPAddress items eg.,
    [[IPv4Address('192.168.42.11'), IPv4Address('192.168.42.15')],
     [IPv4Address('192.168.42.30'), IPv4Address('192.168.42.60')]]
255

256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
    """
    if pool_list[0][0] <= cidr.network:
        raise api.faults.Conflict("IP Pool out of bounds")
    elif pool_list[-1][1] >= cidr.broadcast:
        raise api.faults.Conflict("IP Pool out of bounds")

    for start, end in pool_list:
        if start > end:
            raise api.faults.Conflict("Invalid IP pool range")
        # Raise BadRequest if gateway is inside the pool range
        if not (gateway < start or gateway > end):
            raise api.faults.Conflict("Gateway cannot be in pool range")

    # Check if there is a conflict between the IP Poll ranges
    end = cidr.network
    for pool in pool_list:
        if end >= pool[0]:
            raise api.faults.Conflict("IP Pool range conflict")
        end = pool[1]
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319


def validate_subnet_params(subnet=None, gateway=None, subnet6=None,
                           gateway6=None):
    if subnet:
        try:
            # Use strict option to not all subnets with host bits set
            network = ipaddr.IPv4Network(subnet, strict=True)
        except ValueError:
            raise faults.BadRequest("Invalid network IPv4 subnet")

        # Check that network size is allowed!
        prefixlen = network.prefixlen
        if prefixlen > 29 or prefixlen <= settings.MAX_CIDR_BLOCK:
            raise faults.OverLimit(
                message="Unsupported network size",
                details="Netmask must be in range: (%s, 29]" %
                settings.MAX_CIDR_BLOCK)
        if gateway:  # Check that gateway belongs to network
            try:
                gateway = ipaddr.IPv4Address(gateway)
            except ValueError:
                raise faults.BadRequest("Invalid network IPv4 gateway")
            if not gateway in network:
                raise faults.BadRequest("Invalid network IPv4 gateway")

    if subnet6:
        try:
            # Use strict option to not all subnets with host bits set
            network6 = ipaddr.IPv6Network(subnet6, strict=True)
        except ValueError:
            raise faults.BadRequest("Invalid network IPv6 subnet")
        # Check that network6 is an /64 subnet, because this is imposed by
        # 'mac2eui64' utiity.
        if network6.prefixlen != 64:
            msg = ("Unsupported IPv6 subnet size. Network netmask must be"
                   " /64")
            raise faults.BadRequest(msg)
        if gateway6:
            try:
                gateway6 = ipaddr.IPv6Address(gateway6)
            except ValueError:
                raise faults.BadRequest("Invalid network IPv6 gateway")
            if not gateway6 in network6:
                raise faults.BadRequest("Invalid network IPv6 gateway")