subnets.py 9.44 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
34
35
36
37
# 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.

from logging import getLogger
from snf_django.lib import api
from snf_django.lib.api import faults

38
from django.conf.urls import patterns
39
40
41
42
from django.http import HttpResponse
from django.utils import simplejson as json

from snf_django.lib.api import utils
43
from synnefo.db.models import Subnet, Network, IPPoolTable
44
from synnefo.logic import networks, subnets
45

46
from ipaddr import IPv4Network, IPv6Network, IPv4Address, IPAddress, IPNetwork
47
48
49
50

log = getLogger(__name__)


51
52
53
54
55
56
urlpatterns = patterns(
    'synnefo.api.subnets',
    (r'^(?:/|.json|.xml)?$', 'demux'),
    (r'^/([-\w]+)(?:/|.json|.xml)?$', 'subnet_demux'))


57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
def demux(request):
    if request.method == 'GET':
        return list_subnets(request)
    elif request.method == 'POST':
        return create_subnet(request)
    else:
        return api.api_method_not_allowed(request)


def subnet_demux(request, sub_id):
    if request.method == 'GET':
        return get_subnet(request, sub_id)
    elif request.method == 'DELETE':
        return delete_subnet(request, sub_id)
    elif request.method == 'PUT':
        return update_subnet(request, sub_id)
    else:
        return api.api_method_not_allowed(request)


@api.api_method(http_method='GET', user_required=True, logger=log)
def list_subnets(request):
    """List all subnets of a user"""
80
81
82
83
    subnet_list = subnets.list_subnets(request.user_uniq)
    subnets_dict = [subnet_to_dict(sub)
                    for sub in subnet_list.order_by('id')]

84
85
86
87
88
89
90
    data = json.dumps({'subnets': subnets_dict})

    return HttpResponse(data, status=200)


@api.api_method(http_method='POST', user_required=True, logger=log)
def create_subnet(request):
91
    """Create a subnet
92
    network_id and the desired cidr are mandatory, everything else is optional
93

94
    """
95
96
97
98
99
100
101
102
103
104
105
    dictionary = utils.get_request_dict(request)
    log.info('create subnet %s', dictionary)

    try:
        subnet = dictionary['subnet']
        network_id = subnet['network_id']
        cidr = subnet['cidr']
    except KeyError:
        raise api.faults.BadRequest("Malformed request")

    allocation_pools = subnet.get('allocation_pools', None)
106
    if allocation_pools is not None:
107
108
109
        pool = parse_ip_pools(allocation_pools)
        allocation_pools = string_to_ipaddr(pool)

110
111
    name = subnet.get('name', None)
    ipversion = subnet.get('ip_version', 4)
112
113
114
    # If no gateway is specified, send an empty string, because None is used
    # if the user wants no gateway at all
    gateway = subnet.get('gateway_ip', "")
115
116
117
118
119
    dhcp = subnet.get('enable_dhcp', True)
    slac = subnet.get('enable_slac', None)
    dns = subnet.get('dns_nameservers', None)
    hosts = subnet.get('host_routes', None)

120
121
122
123
124
125
126
127
128
129
130
    sub = subnets.create_subnet(network_id=network_id,
                                cidr=cidr,
                                name=name,
                                ipversion=ipversion,
                                gateway=gateway,
                                dhcp=dhcp,
                                slac=slac,
                                dns_nameservers=dns,
                                allocation_pools=allocation_pools,
                                host_routes=hosts,
                                user_id=request.user_uniq)
131
132
133
134
135
136
137
138
139
140

    subnet_dict = subnet_to_dict(sub)
    data = json.dumps({'subnet': subnet_dict})
    return HttpResponse(data, status=200)


@api.api_method(http_method='GET', user_required=True, logger=log)
def get_subnet(request, sub_id):
    """Show info of a specific subnet"""
    user_id = request.user_uniq
141
    subnet = subnets.get_subnet(sub_id)
142
143
144
145

    if subnet.network.userid != user_id:
        raise api.failts.Unauthorized("You're not allowed to view this subnet")

146
    subnet_dict = subnet_to_dict(subnet)
147
148
149
150
151
152
    data = json.dumps({'subnet': subnet_dict})
    return HttpResponse(data, status=200)


@api.api_method(http_method='DELETE', user_required=True, logger=log)
def delete_subnet(request, sub_id):
153
    """Delete a subnet, raises BadRequest
154
    A subnet is deleted ONLY when the network that it belongs to is deleted
155

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


@api.api_method(http_method='PUT', user_required=True, logger=log)
def update_subnet(request, sub_id):
162
    """Update the fields of a subnet
163
    Only the name can be updated, everything else returns BadRequest
164

165
166
167
168
169
170
171
172
173
174
    """

    dictionary = utils.get_request_dict(request)
    user_id = request.user_uniq

    try:
        subnet = dictionary['subnet']
    except KeyError:
        raise api.faults.BadRequest("Malformed request")

175
    if len(subnet) != 1 or "name" not in subnet:
176
177
178
179
        raise api.faults.BadRequest("Only the name of subnet can be updated")

    name = subnet.get("name", None)

180
    subnet_dict = subnet_to_dict(subnets.update_subnet(sub_id, name))
181
182
183
184
185
186
187
    data = json.dumps({'subnet': subnet_dict})
    return HttpResponse(data, status=200)


#Utility functions
def subnet_to_dict(subnet):
    """Returns a dictionary containing the info of a subnet"""
188
189
    dns = check_empty_lists(subnet.dns_nameservers)
    hosts = check_empty_lists(subnet.host_routes)
190
191
192
193
194
195
196
197
    allocation_pools = subnet.ip_pools.all()
    pools = list()

    if allocation_pools:
        for pool in allocation_pools:
            cidr = IPNetwork(pool.base)
            start = str(cidr.network + pool.offset)
            end = str(cidr.network + pool.offset + pool.size - 1)
198
            pools.append({"start": start, "end": end})
199
200
201
202
203
204

    dictionary = dict({'id': str(subnet.id),
                       'network_id': str(subnet.network.id),
                       'name': subnet.name if subnet.name is not None else "",
                       'tenant_id': subnet.network.userid,
                       'user_id': subnet.network.userid,
205
                       'gateway_ip': subnet.gateway,
206
207
                       'ip_version': subnet.ipversion,
                       'cidr': subnet.cidr,
208
                       'enable_dhcp': subnet.dhcp,
209
210
                       'dns_nameservers': dns,
                       'host_routes': hosts,
211
                       'allocation_pools': pools if pools is not None else []})
212
213

    if subnet.ipversion == 6:
214
        dictionary['enable_slac'] = subnet.dhcp
215

216
217
218
    return dictionary


219
def string_to_ipaddr(pools):
220
221
    """Convert [["192.168.42.1", "192.168.42.15"],
                ["192.168.42.30", "192.168.42.60"]]
222
    to
223
224
                [[IPv4Address('192.168.42.1'), IPv4Address('192.168.42.15')],
                [IPv4Address('192.168.42.30'), IPv4Address('192.168.42.60')]]
225
    and sort the output
226

227
228
229
230
231
232
233
    """
    pool_list = [(map(lambda ip_str: IPAddress(ip_str), pool))
                 for pool in pools]
    pool_list.sort()
    return pool_list


234
235
236
237
238
239
240
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


241
242
243
244
245
246
247
248
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):
249
    """Return a Subnet instance or raise ItemNotFound.
250
    This is the same as util.get_network
251

252
253
254
255
256
257
258
259
260
    """
    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):
261
        raise api.faults.ItemNotFound('Subnet not found')
262
263
264


def parse_ip_pools(pools):
265
    """Convert [{'start': '192.168.42.1', 'end': '192.168.42.15'},
266
267
268
269
             {'start': '192.168.42.30', 'end': '192.168.42.60'}]
    to
            [["192.168.42.1", "192.168.42.15"],
             ["192.168.42.30", "192.168.42.60"]]
270

271
272
273
    """
    pool_list = list()
    for pool in pools:
274
275
        parse = [pool["start"], pool["end"]]
        pool_list.append(parse)
276
    return pool_list