-
Notifications
You must be signed in to change notification settings - Fork 2
/
utils.py
377 lines (308 loc) · 10.9 KB
/
utils.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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
import requests
import re
from sshpubkeys.exceptions import InvalidKeyError
from models import Capsule, RoleEnum, SizeEnum, WebApp
from models import User, AppToken
from flask import current_app, g, request
from exceptions import KeycloakIdNotFound, KeycloakUserNotFound
from werkzeug.exceptions import BadRequest, Forbidden
from werkzeug.exceptions import ServiceUnavailable
import OpenSSL
from functools import wraps
from app import oidc, db
from inspect import signature
from sqlalchemy.util import symbol
from hashlib import sha512
from sshpubkeys import SSHKey
from sqlalchemy.exc import OperationalError
import datetime
import base64
OIDC_CONFIG = None
def is_valid_name(name):
if len(name) > 64:
return False
# WARNING: a capsule name will be the name of a namespace in k8s.
# https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
pattern = re.compile('^[a-z0-9][-a-z0-9]*[a-z0-9]$')
if pattern.match(name):
return True
else:
return False
def check_owners_on_keycloak(usernames): # pragma: no cover
oidc_client_secrets = current_app.config['OIDC_CLIENT_SECRETS']['web']
token_uri = oidc_client_secrets['token_uri']
admin_uri = oidc_client_secrets['admin_uri']
client_id = oidc_client_secrets['client_id']
client_secret = oidc_client_secrets['client_secret']
token_res = requests.post(
token_uri,
data={
'grant_type': 'client_credentials',
'client_id': client_id,
'client_secret': client_secret,
},
timeout=1,
).json()
access_token = token_res['access_token']
for username in usernames:
if username == "":
raise KeycloakUserNotFound("empty username")
res = requests.get(
f'{admin_uri}/users?username={username}',
headers={
'Accept': 'application/json',
'Authorization': f'Bearer {access_token}',
},
timeout=1,
).json()
if not res:
raise KeycloakUserNotFound(username)
def oidc_require_role(min_role):
def decorator(view_func):
@wraps(view_func)
@require_auth
def wrapper(*args, **kwargs):
user = check_user_role(min_role)
sig = signature(view_func)
if "user" in sig.parameters:
kwargs["user"] = user
return view_func(*args, **kwargs)
return wrapper
return decorator
def require_auth(view_func):
def wrapper(*args, **kwargs):
try:
token = request.headers['Authorization'].split(None, 1)[1].strip()
(validity, username) = check_apptoken(token)
except KeyError:
validity = False
if validity:
g.capsule_app_token = username
return view_func(*args, **kwargs)
else: # Fallback on Keycloak auth
return oidc.accept_token(
require_token=True,
render_errors=False
)(view_func)(*args, **kwargs)
return wrapper
def check_apptoken(token):
hashed_token = sha512(token.encode('ascii')).hexdigest()
try:
apptoken = AppToken.query.filter_by(token=hashed_token).first()
except OperationalError: # pragma: no cover
raise ServiceUnavailable("The database is unreachable.")
if apptoken is not None:
username = apptoken.user.name
return (True, username)
else:
return (False, None)
def check_user_role(min_role=RoleEnum.admin):
if hasattr(g, 'capsule_app_token'): # Get user name from application token
name = g.capsule_app_token
else: # Keycloak auth # pragma: no cover
kc_user_id = g.oidc_token_info['sub']
try:
name = get_user_from_keycloak(kc_user_id)
except KeycloakIdNotFound as e:
raise BadRequest(description=f'{e.missing_id} is an invalid id.')
# Look for user role
user = User.query.filter_by(name=name).one_or_none()
if user is None: # pragma: no cover
if name in current_app.config['ADMINS']:
user = User(
name=name,
role=RoleEnum.admin,
parts_manager=True
)
elif name in current_app.config['SUPERADMINS']:
user = User(
name=name,
role=RoleEnum.superadmin,
parts_manager=True
)
else:
user = User(name=name, role=RoleEnum.user)
db.session.add(user)
db.session.commit()
if user.role < min_role:
raise Forbidden
return user
def get_user_from_keycloak(id, by_name=False): # pragma: no cover
oidc_client_secrets = current_app.config['OIDC_CLIENT_SECRETS']['web']
token_uri = oidc_client_secrets['token_uri']
admin_uri = oidc_client_secrets['admin_uri']
client_id = oidc_client_secrets['client_id']
client_secret = oidc_client_secrets['client_secret']
token_res = requests.post(
token_uri,
data={
'grant_type': 'client_credentials',
'client_id': client_id,
'client_secret': client_secret,
},
timeout=1,
).json()
access_token = token_res['access_token']
res = requests.get(
f'{admin_uri}/users/{id}',
headers={
'Accept': 'application/json',
'Authorization': f'Bearer {access_token}',
},
timeout=1,
).json()
if "username" not in res:
raise KeycloakIdNotFound(id)
return res["username"]
def build_query_filters(model_class, filters): # pragma: no cover
query = []
# For instance, with
# http://localhost:5000/v1/capsules?filters[name]=first-test-caps&filters[owners]=user1,user2:
#
# model_class = Capsule
# filters = [
# "name": "first-test-caps",
# "owners": "user1,user2"
# ]
for filter, value in filters.items():
# filter = "name"
# value = "first-test-caps"
field = getattr(model_class, filter)
# filed = Capsule.name
if field is None:
continue
# If the property to filter on is a collection
if hasattr(field.property, 'direction') \
and field.property.direction in \
(symbol('ONETOMANY'), symbol('MANYTOMANY')):
value_class = field.property.entity.mapper.entity
# value_class = User
if hasattr(value_class, '__default_filter__'):
property_to_filter = value_class.__default_filter__
else:
property_to_filter = 'id'
value_class_property = getattr(value_class, property_to_filter)
# value_class_property = User.name
if ',' in value:
values = value.split(',')
for v in values:
query.append(field.any(value_class_property == v))
elif '|' in value:
values = value.split('|')
query.append(field.any(value_class_property.in_(values)))
else:
# For instance with "owners" filter:
# query.append(Capsule.owners.any(User.id == user.id))
query.append(field.any(value_class_property == value))
else:
# query.append(Capsule.name == "first-test-caps"))
query.append(field == value)
return query
def valid_sshkey(public_key):
ssh = SSHKey(public_key, strict=True)
try:
ssh.parse()
except InvalidKeyError:
return False
except NotImplementedError:
return False
return True
def is_keycert_associated(str_key, str_cert):
"""
:type cert: str
:type private_key: str
:rtype: bool
"""
try:
private_key_obj = OpenSSL.crypto.load_privatekey(
OpenSSL.crypto.FILETYPE_PEM,
# str_key.decode('ascii'),
str_key,
)
except OpenSSL.crypto.Error:
raise BadRequest('The private key is not a valid PEM file')
try:
cert_obj = OpenSSL.crypto.load_certificate(
OpenSSL.crypto.FILETYPE_PEM,
# str_cert.decode('ascii'),
str_cert,
)
except OpenSSL.crypto.Error:
raise BadRequest('The certificate is not a valid PEM file')
context = OpenSSL.SSL.Context(OpenSSL.SSL.TLSv1_METHOD)
context.use_privatekey(private_key_obj)
context.use_certificate(cert_obj)
try:
context.check_privatekey()
return True
except OpenSSL.SSL.Error:
return False
def getClusterPartsUsage(capsule_name):
capsules = Capsule.query.filter(Capsule.name != capsule_name)
parts = 0
for capsule in capsules:
capsule_parts = SizeEnum.getparts(capsule.size)
parts = parts + capsule_parts
return parts
def getWebappsVolumeUsage(webapp_id=None):
webapps = WebApp.query.filter(WebApp.id != webapp_id)
used = 0
for webapp in webapps:
used = used + webapp.volume_size
return used
def get_certificate_cn(x509cert):
cert = OpenSSL.crypto.load_certificate(
OpenSSL.crypto.FILETYPE_PEM, base64.b64decode(x509cert)
)
subject = cert.get_subject()
if "CN=" in str(subject):
return subject.CN
else:
res = str(subject)\
.replace("<X509Name object '/", '')\
.replace("'>", '').replace('/', ', ')
return res
def get_certificate_san(x509cert):
cert = OpenSSL.crypto.load_certificate(
OpenSSL.crypto.FILETYPE_PEM, base64.b64decode(x509cert)
)
san = ''
ext_count = cert.get_extension_count()
for i in range(0, ext_count):
ext = cert.get_extension(i)
if 'subjectAltName' in str(ext.get_short_name()):
san = ext.__str__()
if len(san) > 0:
dns_array = san.split("DNS:")
san = []
for dns in dns_array:
if len(dns) > 0:
san.append(dns.replace(', ', ''))
else:
san = ['']
return san
def get_certificate_notBefore(x509cert):
cert = OpenSSL.crypto.load_certificate(
OpenSSL.crypto.FILETYPE_PEM, base64.b64decode(x509cert)
)
notBeforeString = cert.get_notBefore().decode("utf-8").replace('Z', '')
return datetime.datetime.strptime(notBeforeString, '%Y%m%d%H%M%S')
def get_certificate_notAfter(x509cert):
cert = OpenSSL.crypto.load_certificate(
OpenSSL.crypto.FILETYPE_PEM, base64.b64decode(x509cert)
)
notBeforeString = cert.get_notAfter().decode("utf-8").replace('Z', '')
return datetime.datetime.strptime(notBeforeString, '%Y%m%d%H%M%S')
def get_certificate_hasExpired(x509cert):
cert = OpenSSL.crypto.load_certificate(
OpenSSL.crypto.FILETYPE_PEM, base64.b64decode(x509cert)
)
return cert.has_expired()
def get_certificate_issuer(x509cert):
cert = OpenSSL.crypto.load_certificate(
OpenSSL.crypto.FILETYPE_PEM, base64.b64decode(x509cert)
)
issuer = str(cert.get_issuer())\
.replace("<X509Name object '/", '')\
.replace("'>", '').replace('/', ', ')
return issuer