/
models.py
309 lines (253 loc) · 10.6 KB
/
models.py
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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
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
'''
Created on Jul 4, 2010
@author: jnaous
'''
import re
from django.db import models
from expedient.clearinghouse.aggregate.models import Aggregate
from expedient.common.utils import certtransport
from django.conf import settings
import xmlrpclib
from expedient.clearinghouse.slice.models import Slice
from expedient_geni.utils import create_slice_urn, create_x509_cert,\
create_slice_credential, get_or_create_user_cert, get_user_key_fname,\
get_user_cert_fname, get_ch_urn
from django.db.models import signals
import logging
import traceback
from urlparse import urlparse
from expedient.common.utils.transport import TestClientTransport
from sfa.trust.gid import GID
from expedient.common.tests.utils import test_to_http
from expedient.common.middleware import threadlocals
from expedient.common.timer.models import Job
from expedient.common.timer.exceptions import JobAlreadyScheduled
logger = logging.getLogger("expedient_geni.models")
SSH_KEY_SIZE = 2048
class GENISliceInfo(models.Model):
"""
Holds information about the slice that's relevant for the GENI API.
@ivar slice: The slice to which this information belongs.
@type slice: OneToOneField to L{Slice}.
@ivar slice_urn: the slice's unique resource name. This will be
automatically created in the __init__ function if not given.
@type slice_urn: a string.
@ivar slice_gid: the slice's certificate. This will be
automatically created in the __init__ function if not given.
@type slice_gid: a string.
@ivar ssh_public_key: Public ssh key in base64. Can be None.
@type ssh_public_key: string or None.
@ivar ssh_private_key: Private ssh key in base64, possibly encrypted.
See L{generate_ssh_keys}. Can be None.
@type ssh_private_key: string or None.
"""
slice = models.OneToOneField(
Slice, related_name="geni_slice_info")
slice_urn = models.CharField(max_length=256)
slice_gid = models.TextField("Slice's GID", editable=False)
ssh_public_key = models.TextField(
"Slice's SSH public key", editable=False, blank=True, null=True)
ssh_private_key = models.TextField(
"Slice's SSH private key", editable=False, blank=True, null=True)
def __init__(self, *args, **kwargs):
urn = kwargs.setdefault("slice_urn", create_slice_urn())
kwargs.setdefault(
"slice_gid", create_x509_cert(urn)[0].save_to_string())
super(GENISliceInfo, self).__init__(*args, **kwargs)
def generate_ssh_keys(self, password=None):
"""
Set the C{ssh_public_key} and C{ssh_private_key} attributes to be
new keys. Note that the keys are stored in base64.
@parameter password: password to use to encrypt the private key
@type password: string
"""
from paramiko import RSAKey
from StringIO import StringIO
key = RSAKey.generate(SSH_KEY_SIZE)
output = StringIO()
key.write_private_key(output, password=password)
self.ssh_private_key = output.getvalue()
output.close()
self.ssh_public_key = \
"ssh-rsa %s auto-generated Expedient key" % (key.get_base64())
def login_username(self):
"""
Get the PlanetLab login username from the slice URN.
"""
parts = self.slice_urn.split("+")
name = parts[-1]
name = re.sub(r"[^0-9a-z_]", "", name)
prefix = parts[1]
base = prefix.split(":")[-1]
return base+"_"+name
def _add_geni_slice_info(sender, instance=None, created=None, **kwargs):
"""Called to create a slice info for a new Slice instance.
Mainly so that all slices have a slice_urn associated.
"""
if created: GENISliceInfo.objects.create(slice=instance)
signals.post_save.connect(_add_geni_slice_info, Slice)
class GENIAggregate(Aggregate):
"""
Implements a generic GCF-based aggregate manager to simplify adding
GCF-based plugins.
"""
url = models.CharField(max_length=200)
class URLNotDefined(Exception): pass
def _get_client(self, cert_fname, key_fname):
try:
u = self.url
except AttributeError:
raise self.URLNotDefined("URL not set.")
if not u:
raise self.URLNotDefined("URL not set.")
parsed = urlparse(u.lower())
if parsed.scheme == "test":
user_cert = GID(filename=cert_fname).save_to_string()
transport = TestClientTransport(defaults={
"REMOTE_USER": user_cert, "SSL_CLIENT_CERT": user_cert})
proxy = xmlrpclib.ServerProxy(
test_to_http(u),
transport=transport,
)
else:
transport = certtransport.SafeTransportWithCert(
keyfile=key_fname,
certfile=cert_fname)
proxy = xmlrpclib.ServerProxy(u, transport=transport)
return proxy
def get_user_client(self, user):
"""Get a client to talk to the aggregate as the user."""
return self._get_client(
get_user_cert_fname(user), get_user_key_fname(user))
def get_expedient_client(self):
"""Get a client to talk to the aggregate as Expedient."""
return self._get_client(
settings.GCF_X509_CH_CERT, settings.GCF_X509_CH_KEY)
@classmethod
def get_am_cred(cls):
"""
Get the slice authority credentials to use for AM calls.
@return: GENI credential string.
"""
slice_urn = create_slice_urn()
slice_gid, _ = create_x509_cert(slice_urn)
user_gid = GID(filename=settings.GCF_X509_CH_CERT)
ucred = create_slice_credential(user_gid, slice_gid)
return ucred.save_to_string()
def get_slice_cred(self, slice, user):
info = slice.geni_slice_info
user_cert = get_or_create_user_cert(user)
return create_slice_credential(
user_cert, GID(string=str(info.slice_gid))
).save_to_string()
def _create_sliver(self, slice):
"""
Corresponds to the CreateSliver call of the GENI aggregate API.
Creates a sliver on the aggregate from this slice.
"""
logger.debug("Called GENIAggregate._create_sliver")
user = threadlocals.get_thread_locals()["user"]
rspec = self.as_leaf_class()._to_rspec(slice)
info = GENISliceInfo.objects.get(slice=slice)
slice_cred = self.get_slice_cred(slice, user)
proxy = self.get_user_client(user)
try:
_ = proxy.CreateSliver(
info.slice_urn, [slice_cred], rspec,
[dict(name=settings.GCF_BASE_NAME,
urn=get_ch_urn(),
keys=[info.ssh_public_key])
]
)
except Exception as e:
logger.error(traceback.format_exc())
raise Exception("Error creating sliver: %s" % e)
# TODO: parse reserved slice to see errors and such
def _delete_sliver(self, slice):
"""
Corresponds to the DeleteSliver call of the GENI aggregate API.
Stop and delete slice at the aggregate.
"""
user = threadlocals.get_thread_locals()["user"]
info = GENISliceInfo.objects.get(slice=slice)
# Get the user's cert
slice_cred = self.get_slice_cred(slice, user)
proxy = self.get_user_client(user)
try:
ret = proxy.DeleteSliver(
info.slice_urn, [slice_cred])
except Exception as e:
logger.error(traceback.format_exc())
raise Exception("Error deleting sliver: %s" % e)
return ret
def sliver_status(self, slice):
"""
Corresponds to the SliverStatus call of the GENI aggregate API.
Returns the sliver's status at the aggregate.
"""
# TODO: fill up
raise NotImplementedError()
def update_resources(self):
"""Parse the rspec and update resources in the database.
Pull the rspec from the aggregate and parse it into resources stored
in the database.
"""
proxy = self.get_expedient_client()
rspec = proxy.ListResources(
[self.get_am_cred()],
{"geni_compressed": False, "geni_available": True})
logger.debug("Got rspec:\n%s" % rspec)
self._from_rspec(rspec)
try:
Job.objects.schedule(
settings.GENI_AGGREGATE_UPDATE_PERIOD,
self.update_resources,
)
except JobAlreadyScheduled:
pass
#####################################################################
# Overrides from expedient.clearinghouse.aggregate.models.Aggregate #
#####################################################################
def check_status(self):
proxy = self.get_expedient_client()
try:
ver = proxy.GetVersion()
except Exception as e:
logger.error(traceback.format_exc())
return False
return self.available
def start_slice(self, slice):
super(GENIAggregate, self).start_slice(slice)
return self._create_sliver(slice)
def stop_slice(self, slice):
super(GENIAggregate, self).stop_slice(slice)
return self._delete_sliver(slice)
def add_to_slice(self, slice, next):
"""
Make sure that there's only one GENI slice info.
"""
super(GENIAggregate, self).add_to_slice(slice, next)
info, _ = GENISliceInfo.objects.get_or_create(
slice=slice,
)
if not info.ssh_private_key or not info.ssh_public_key:
info.generate_ssh_keys()
info.save()
return next
#####################################################################
# Subclasses must override the below functions #
#####################################################################
def _to_rspec(self, slice):
"""Change this slice into an rspec for this aggregates
Transform the slice into a reservation RSpec to be used with this
aggregate.
@param slice: The slice to change into a reservation RSpec
@type slice: L{expedient.clearinghouse.slice.models.Slice}
"""
raise NotImplementedError()
def _from_rspec(self, rspec):
"""Parse the rspec and update resources in the database.
@param rspec: The rspec describing the remote resources.
@type rspec: XML C{str}
"""
raise NotImplementedError()