##// END OF EJS Templates
auth: re-use the get_current_request in fetching request in decorators....
marcink -
r1775:f25110de default
parent child Browse files
Show More
@@ -1,1993 +1,2007 b''
1 1 # -*- coding: utf-8 -*-
2 2
3 3 # Copyright (C) 2010-2017 RhodeCode GmbH
4 4 #
5 5 # This program is free software: you can redistribute it and/or modify
6 6 # it under the terms of the GNU Affero General Public License, version 3
7 7 # (only), as published by the Free Software Foundation.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU Affero General Public License
15 15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 16 #
17 17 # This program is dual-licensed. If you wish to learn more about the
18 18 # RhodeCode Enterprise Edition, including its added features, Support services,
19 19 # and proprietary license terms, please see https://rhodecode.com/licenses/
20 20
21 21 """
22 22 authentication and permission libraries
23 23 """
24 24
25 25 import os
26 26 import inspect
27 27 import collections
28 28 import fnmatch
29 29 import hashlib
30 30 import itertools
31 31 import logging
32 32 import random
33 33 import traceback
34 34 from functools import wraps
35 35
36 36 import ipaddress
37 37 from pyramid.httpexceptions import HTTPForbidden, HTTPFound
38 38 from pylons import url, request
39 39 from pylons.controllers.util import abort, redirect
40 40 from pylons.i18n.translation import _
41 41 from sqlalchemy.orm.exc import ObjectDeletedError
42 42 from sqlalchemy.orm import joinedload
43 43 from zope.cachedescriptors.property import Lazy as LazyProperty
44 44
45 45 import rhodecode
46 46 from rhodecode.model import meta
47 47 from rhodecode.model.meta import Session
48 48 from rhodecode.model.user import UserModel
49 49 from rhodecode.model.db import (
50 50 User, Repository, Permission, UserToPerm, UserGroupToPerm, UserGroupMember,
51 51 UserIpMap, UserApiKeys, RepoGroup)
52 52 from rhodecode.lib import caches
53 53 from rhodecode.lib.utils2 import safe_unicode, aslist, safe_str, md5
54 54 from rhodecode.lib.utils import (
55 55 get_repo_slug, get_repo_group_slug, get_user_group_slug)
56 56 from rhodecode.lib.caching_query import FromCache
57 57
58 58
59 59 if rhodecode.is_unix:
60 60 import bcrypt
61 61
62 62 log = logging.getLogger(__name__)
63 63
64 64 csrf_token_key = "csrf_token"
65 65
66 66
67 67 class PasswordGenerator(object):
68 68 """
69 69 This is a simple class for generating password from different sets of
70 70 characters
71 71 usage::
72 72
73 73 passwd_gen = PasswordGenerator()
74 74 #print 8-letter password containing only big and small letters
75 75 of alphabet
76 76 passwd_gen.gen_password(8, passwd_gen.ALPHABETS_BIG_SMALL)
77 77 """
78 78 ALPHABETS_NUM = r'''1234567890'''
79 79 ALPHABETS_SMALL = r'''qwertyuiopasdfghjklzxcvbnm'''
80 80 ALPHABETS_BIG = r'''QWERTYUIOPASDFGHJKLZXCVBNM'''
81 81 ALPHABETS_SPECIAL = r'''`-=[]\;',./~!@#$%^&*()_+{}|:"<>?'''
82 82 ALPHABETS_FULL = ALPHABETS_BIG + ALPHABETS_SMALL \
83 83 + ALPHABETS_NUM + ALPHABETS_SPECIAL
84 84 ALPHABETS_ALPHANUM = ALPHABETS_BIG + ALPHABETS_SMALL + ALPHABETS_NUM
85 85 ALPHABETS_BIG_SMALL = ALPHABETS_BIG + ALPHABETS_SMALL
86 86 ALPHABETS_ALPHANUM_BIG = ALPHABETS_BIG + ALPHABETS_NUM
87 87 ALPHABETS_ALPHANUM_SMALL = ALPHABETS_SMALL + ALPHABETS_NUM
88 88
89 89 def __init__(self, passwd=''):
90 90 self.passwd = passwd
91 91
92 92 def gen_password(self, length, type_=None):
93 93 if type_ is None:
94 94 type_ = self.ALPHABETS_FULL
95 95 self.passwd = ''.join([random.choice(type_) for _ in xrange(length)])
96 96 return self.passwd
97 97
98 98
99 99 class _RhodeCodeCryptoBase(object):
100 100 ENC_PREF = None
101 101
102 102 def hash_create(self, str_):
103 103 """
104 104 hash the string using
105 105
106 106 :param str_: password to hash
107 107 """
108 108 raise NotImplementedError
109 109
110 110 def hash_check_with_upgrade(self, password, hashed):
111 111 """
112 112 Returns tuple in which first element is boolean that states that
113 113 given password matches it's hashed version, and the second is new hash
114 114 of the password, in case this password should be migrated to new
115 115 cipher.
116 116 """
117 117 checked_hash = self.hash_check(password, hashed)
118 118 return checked_hash, None
119 119
120 120 def hash_check(self, password, hashed):
121 121 """
122 122 Checks matching password with it's hashed value.
123 123
124 124 :param password: password
125 125 :param hashed: password in hashed form
126 126 """
127 127 raise NotImplementedError
128 128
129 129 def _assert_bytes(self, value):
130 130 """
131 131 Passing in an `unicode` object can lead to hard to detect issues
132 132 if passwords contain non-ascii characters. Doing a type check
133 133 during runtime, so that such mistakes are detected early on.
134 134 """
135 135 if not isinstance(value, str):
136 136 raise TypeError(
137 137 "Bytestring required as input, got %r." % (value, ))
138 138
139 139
140 140 class _RhodeCodeCryptoBCrypt(_RhodeCodeCryptoBase):
141 141 ENC_PREF = ('$2a$10', '$2b$10')
142 142
143 143 def hash_create(self, str_):
144 144 self._assert_bytes(str_)
145 145 return bcrypt.hashpw(str_, bcrypt.gensalt(10))
146 146
147 147 def hash_check_with_upgrade(self, password, hashed):
148 148 """
149 149 Returns tuple in which first element is boolean that states that
150 150 given password matches it's hashed version, and the second is new hash
151 151 of the password, in case this password should be migrated to new
152 152 cipher.
153 153
154 154 This implements special upgrade logic which works like that:
155 155 - check if the given password == bcrypted hash, if yes then we
156 156 properly used password and it was already in bcrypt. Proceed
157 157 without any changes
158 158 - if bcrypt hash check is not working try with sha256. If hash compare
159 159 is ok, it means we using correct but old hashed password. indicate
160 160 hash change and proceed
161 161 """
162 162
163 163 new_hash = None
164 164
165 165 # regular pw check
166 166 password_match_bcrypt = self.hash_check(password, hashed)
167 167
168 168 # now we want to know if the password was maybe from sha256
169 169 # basically calling _RhodeCodeCryptoSha256().hash_check()
170 170 if not password_match_bcrypt:
171 171 if _RhodeCodeCryptoSha256().hash_check(password, hashed):
172 172 new_hash = self.hash_create(password) # make new bcrypt hash
173 173 password_match_bcrypt = True
174 174
175 175 return password_match_bcrypt, new_hash
176 176
177 177 def hash_check(self, password, hashed):
178 178 """
179 179 Checks matching password with it's hashed value.
180 180
181 181 :param password: password
182 182 :param hashed: password in hashed form
183 183 """
184 184 self._assert_bytes(password)
185 185 try:
186 186 return bcrypt.hashpw(password, hashed) == hashed
187 187 except ValueError as e:
188 188 # we're having a invalid salt here probably, we should not crash
189 189 # just return with False as it would be a wrong password.
190 190 log.debug('Failed to check password hash using bcrypt %s',
191 191 safe_str(e))
192 192
193 193 return False
194 194
195 195
196 196 class _RhodeCodeCryptoSha256(_RhodeCodeCryptoBase):
197 197 ENC_PREF = '_'
198 198
199 199 def hash_create(self, str_):
200 200 self._assert_bytes(str_)
201 201 return hashlib.sha256(str_).hexdigest()
202 202
203 203 def hash_check(self, password, hashed):
204 204 """
205 205 Checks matching password with it's hashed value.
206 206
207 207 :param password: password
208 208 :param hashed: password in hashed form
209 209 """
210 210 self._assert_bytes(password)
211 211 return hashlib.sha256(password).hexdigest() == hashed
212 212
213 213
214 214 class _RhodeCodeCryptoMd5(_RhodeCodeCryptoBase):
215 215 ENC_PREF = '_'
216 216
217 217 def hash_create(self, str_):
218 218 self._assert_bytes(str_)
219 219 return hashlib.md5(str_).hexdigest()
220 220
221 221 def hash_check(self, password, hashed):
222 222 """
223 223 Checks matching password with it's hashed value.
224 224
225 225 :param password: password
226 226 :param hashed: password in hashed form
227 227 """
228 228 self._assert_bytes(password)
229 229 return hashlib.md5(password).hexdigest() == hashed
230 230
231 231
232 232 def crypto_backend():
233 233 """
234 234 Return the matching crypto backend.
235 235
236 236 Selection is based on if we run tests or not, we pick md5 backend to run
237 237 tests faster since BCRYPT is expensive to calculate
238 238 """
239 239 if rhodecode.is_test:
240 240 RhodeCodeCrypto = _RhodeCodeCryptoMd5()
241 241 else:
242 242 RhodeCodeCrypto = _RhodeCodeCryptoBCrypt()
243 243
244 244 return RhodeCodeCrypto
245 245
246 246
247 247 def get_crypt_password(password):
248 248 """
249 249 Create the hash of `password` with the active crypto backend.
250 250
251 251 :param password: The cleartext password.
252 252 :type password: unicode
253 253 """
254 254 password = safe_str(password)
255 255 return crypto_backend().hash_create(password)
256 256
257 257
258 258 def check_password(password, hashed):
259 259 """
260 260 Check if the value in `password` matches the hash in `hashed`.
261 261
262 262 :param password: The cleartext password.
263 263 :type password: unicode
264 264
265 265 :param hashed: The expected hashed version of the password.
266 266 :type hashed: The hash has to be passed in in text representation.
267 267 """
268 268 password = safe_str(password)
269 269 return crypto_backend().hash_check(password, hashed)
270 270
271 271
272 272 def generate_auth_token(data, salt=None):
273 273 """
274 274 Generates API KEY from given string
275 275 """
276 276
277 277 if salt is None:
278 278 salt = os.urandom(16)
279 279 return hashlib.sha1(safe_str(data) + salt).hexdigest()
280 280
281 281
282 282 class CookieStoreWrapper(object):
283 283
284 284 def __init__(self, cookie_store):
285 285 self.cookie_store = cookie_store
286 286
287 287 def __repr__(self):
288 288 return 'CookieStore<%s>' % (self.cookie_store)
289 289
290 290 def get(self, key, other=None):
291 291 if isinstance(self.cookie_store, dict):
292 292 return self.cookie_store.get(key, other)
293 293 elif isinstance(self.cookie_store, AuthUser):
294 294 return self.cookie_store.__dict__.get(key, other)
295 295
296 296
297 297 def _cached_perms_data(user_id, scope, user_is_admin,
298 298 user_inherit_default_permissions, explicit, algo):
299 299
300 300 permissions = PermissionCalculator(
301 301 user_id, scope, user_is_admin, user_inherit_default_permissions,
302 302 explicit, algo)
303 303 return permissions.calculate()
304 304
305 305 class PermOrigin:
306 306 ADMIN = 'superadmin'
307 307
308 308 REPO_USER = 'user:%s'
309 309 REPO_USERGROUP = 'usergroup:%s'
310 310 REPO_OWNER = 'repo.owner'
311 311 REPO_DEFAULT = 'repo.default'
312 312 REPO_PRIVATE = 'repo.private'
313 313
314 314 REPOGROUP_USER = 'user:%s'
315 315 REPOGROUP_USERGROUP = 'usergroup:%s'
316 316 REPOGROUP_OWNER = 'group.owner'
317 317 REPOGROUP_DEFAULT = 'group.default'
318 318
319 319 USERGROUP_USER = 'user:%s'
320 320 USERGROUP_USERGROUP = 'usergroup:%s'
321 321 USERGROUP_OWNER = 'usergroup.owner'
322 322 USERGROUP_DEFAULT = 'usergroup.default'
323 323
324 324
325 325 class PermOriginDict(dict):
326 326 """
327 327 A special dict used for tracking permissions along with their origins.
328 328
329 329 `__setitem__` has been overridden to expect a tuple(perm, origin)
330 330 `__getitem__` will return only the perm
331 331 `.perm_origin_stack` will return the stack of (perm, origin) set per key
332 332
333 333 >>> perms = PermOriginDict()
334 334 >>> perms['resource'] = 'read', 'default'
335 335 >>> perms['resource']
336 336 'read'
337 337 >>> perms['resource'] = 'write', 'admin'
338 338 >>> perms['resource']
339 339 'write'
340 340 >>> perms.perm_origin_stack
341 341 {'resource': [('read', 'default'), ('write', 'admin')]}
342 342 """
343 343
344 344
345 345 def __init__(self, *args, **kw):
346 346 dict.__init__(self, *args, **kw)
347 347 self.perm_origin_stack = {}
348 348
349 349 def __setitem__(self, key, (perm, origin)):
350 350 self.perm_origin_stack.setdefault(key, []).append((perm, origin))
351 351 dict.__setitem__(self, key, perm)
352 352
353 353
354 354 class PermissionCalculator(object):
355 355
356 356 def __init__(
357 357 self, user_id, scope, user_is_admin,
358 358 user_inherit_default_permissions, explicit, algo):
359 359 self.user_id = user_id
360 360 self.user_is_admin = user_is_admin
361 361 self.inherit_default_permissions = user_inherit_default_permissions
362 362 self.explicit = explicit
363 363 self.algo = algo
364 364
365 365 scope = scope or {}
366 366 self.scope_repo_id = scope.get('repo_id')
367 367 self.scope_repo_group_id = scope.get('repo_group_id')
368 368 self.scope_user_group_id = scope.get('user_group_id')
369 369
370 370 self.default_user_id = User.get_default_user(cache=True).user_id
371 371
372 372 self.permissions_repositories = PermOriginDict()
373 373 self.permissions_repository_groups = PermOriginDict()
374 374 self.permissions_user_groups = PermOriginDict()
375 375 self.permissions_global = set()
376 376
377 377 self.default_repo_perms = Permission.get_default_repo_perms(
378 378 self.default_user_id, self.scope_repo_id)
379 379 self.default_repo_groups_perms = Permission.get_default_group_perms(
380 380 self.default_user_id, self.scope_repo_group_id)
381 381 self.default_user_group_perms = \
382 382 Permission.get_default_user_group_perms(
383 383 self.default_user_id, self.scope_user_group_id)
384 384
385 385 def calculate(self):
386 386 if self.user_is_admin:
387 387 return self._admin_permissions()
388 388
389 389 self._calculate_global_default_permissions()
390 390 self._calculate_global_permissions()
391 391 self._calculate_default_permissions()
392 392 self._calculate_repository_permissions()
393 393 self._calculate_repository_group_permissions()
394 394 self._calculate_user_group_permissions()
395 395 return self._permission_structure()
396 396
397 397 def _admin_permissions(self):
398 398 """
399 399 admin user have all default rights for repositories
400 400 and groups set to admin
401 401 """
402 402 self.permissions_global.add('hg.admin')
403 403 self.permissions_global.add('hg.create.write_on_repogroup.true')
404 404
405 405 # repositories
406 406 for perm in self.default_repo_perms:
407 407 r_k = perm.UserRepoToPerm.repository.repo_name
408 408 p = 'repository.admin'
409 409 self.permissions_repositories[r_k] = p, PermOrigin.ADMIN
410 410
411 411 # repository groups
412 412 for perm in self.default_repo_groups_perms:
413 413 rg_k = perm.UserRepoGroupToPerm.group.group_name
414 414 p = 'group.admin'
415 415 self.permissions_repository_groups[rg_k] = p, PermOrigin.ADMIN
416 416
417 417 # user groups
418 418 for perm in self.default_user_group_perms:
419 419 u_k = perm.UserUserGroupToPerm.user_group.users_group_name
420 420 p = 'usergroup.admin'
421 421 self.permissions_user_groups[u_k] = p, PermOrigin.ADMIN
422 422
423 423 return self._permission_structure()
424 424
425 425 def _calculate_global_default_permissions(self):
426 426 """
427 427 global permissions taken from the default user
428 428 """
429 429 default_global_perms = UserToPerm.query()\
430 430 .filter(UserToPerm.user_id == self.default_user_id)\
431 431 .options(joinedload(UserToPerm.permission))
432 432
433 433 for perm in default_global_perms:
434 434 self.permissions_global.add(perm.permission.permission_name)
435 435
436 436 def _calculate_global_permissions(self):
437 437 """
438 438 Set global system permissions with user permissions or permissions
439 439 taken from the user groups of the current user.
440 440
441 441 The permissions include repo creating, repo group creating, forking
442 442 etc.
443 443 """
444 444
445 445 # now we read the defined permissions and overwrite what we have set
446 446 # before those can be configured from groups or users explicitly.
447 447
448 448 # TODO: johbo: This seems to be out of sync, find out the reason
449 449 # for the comment below and update it.
450 450
451 451 # In case we want to extend this list we should be always in sync with
452 452 # User.DEFAULT_USER_PERMISSIONS definitions
453 453 _configurable = frozenset([
454 454 'hg.fork.none', 'hg.fork.repository',
455 455 'hg.create.none', 'hg.create.repository',
456 456 'hg.usergroup.create.false', 'hg.usergroup.create.true',
457 457 'hg.repogroup.create.false', 'hg.repogroup.create.true',
458 458 'hg.create.write_on_repogroup.false',
459 459 'hg.create.write_on_repogroup.true',
460 460 'hg.inherit_default_perms.false', 'hg.inherit_default_perms.true'
461 461 ])
462 462
463 463 # USER GROUPS comes first user group global permissions
464 464 user_perms_from_users_groups = Session().query(UserGroupToPerm)\
465 465 .options(joinedload(UserGroupToPerm.permission))\
466 466 .join((UserGroupMember, UserGroupToPerm.users_group_id ==
467 467 UserGroupMember.users_group_id))\
468 468 .filter(UserGroupMember.user_id == self.user_id)\
469 469 .order_by(UserGroupToPerm.users_group_id)\
470 470 .all()
471 471
472 472 # need to group here by groups since user can be in more than
473 473 # one group, so we get all groups
474 474 _explicit_grouped_perms = [
475 475 [x, list(y)] for x, y in
476 476 itertools.groupby(user_perms_from_users_groups,
477 477 lambda _x: _x.users_group)]
478 478
479 479 for gr, perms in _explicit_grouped_perms:
480 480 # since user can be in multiple groups iterate over them and
481 481 # select the lowest permissions first (more explicit)
482 482 # TODO: marcink: do this^^
483 483
484 484 # group doesn't inherit default permissions so we actually set them
485 485 if not gr.inherit_default_permissions:
486 486 # NEED TO IGNORE all previously set configurable permissions
487 487 # and replace them with explicitly set from this user
488 488 # group permissions
489 489 self.permissions_global = self.permissions_global.difference(
490 490 _configurable)
491 491 for perm in perms:
492 492 self.permissions_global.add(perm.permission.permission_name)
493 493
494 494 # user explicit global permissions
495 495 user_perms = Session().query(UserToPerm)\
496 496 .options(joinedload(UserToPerm.permission))\
497 497 .filter(UserToPerm.user_id == self.user_id).all()
498 498
499 499 if not self.inherit_default_permissions:
500 500 # NEED TO IGNORE all configurable permissions and
501 501 # replace them with explicitly set from this user permissions
502 502 self.permissions_global = self.permissions_global.difference(
503 503 _configurable)
504 504 for perm in user_perms:
505 505 self.permissions_global.add(perm.permission.permission_name)
506 506
507 507 def _calculate_default_permissions(self):
508 508 """
509 509 Set default user permissions for repositories, repository groups
510 510 taken from the default user.
511 511
512 512 Calculate inheritance of object permissions based on what we have now
513 513 in GLOBAL permissions. We check if .false is in GLOBAL since this is
514 514 explicitly set. Inherit is the opposite of .false being there.
515 515
516 516 .. note::
517 517
518 518 the syntax is little bit odd but what we need to check here is
519 519 the opposite of .false permission being in the list so even for
520 520 inconsistent state when both .true/.false is there
521 521 .false is more important
522 522
523 523 """
524 524 user_inherit_object_permissions = not ('hg.inherit_default_perms.false'
525 525 in self.permissions_global)
526 526
527 527 # defaults for repositories, taken from `default` user permissions
528 528 # on given repo
529 529 for perm in self.default_repo_perms:
530 530 r_k = perm.UserRepoToPerm.repository.repo_name
531 531 o = PermOrigin.REPO_DEFAULT
532 532 if perm.Repository.private and not (
533 533 perm.Repository.user_id == self.user_id):
534 534 # disable defaults for private repos,
535 535 p = 'repository.none'
536 536 o = PermOrigin.REPO_PRIVATE
537 537 elif perm.Repository.user_id == self.user_id:
538 538 # set admin if owner
539 539 p = 'repository.admin'
540 540 o = PermOrigin.REPO_OWNER
541 541 else:
542 542 p = perm.Permission.permission_name
543 543 # if we decide this user isn't inheriting permissions from
544 544 # default user we set him to .none so only explicit
545 545 # permissions work
546 546 if not user_inherit_object_permissions:
547 547 p = 'repository.none'
548 548 self.permissions_repositories[r_k] = p, o
549 549
550 550 # defaults for repository groups taken from `default` user permission
551 551 # on given group
552 552 for perm in self.default_repo_groups_perms:
553 553 rg_k = perm.UserRepoGroupToPerm.group.group_name
554 554 o = PermOrigin.REPOGROUP_DEFAULT
555 555 if perm.RepoGroup.user_id == self.user_id:
556 556 # set admin if owner
557 557 p = 'group.admin'
558 558 o = PermOrigin.REPOGROUP_OWNER
559 559 else:
560 560 p = perm.Permission.permission_name
561 561
562 562 # if we decide this user isn't inheriting permissions from default
563 563 # user we set him to .none so only explicit permissions work
564 564 if not user_inherit_object_permissions:
565 565 p = 'group.none'
566 566 self.permissions_repository_groups[rg_k] = p, o
567 567
568 568 # defaults for user groups taken from `default` user permission
569 569 # on given user group
570 570 for perm in self.default_user_group_perms:
571 571 u_k = perm.UserUserGroupToPerm.user_group.users_group_name
572 572 o = PermOrigin.USERGROUP_DEFAULT
573 573 if perm.UserGroup.user_id == self.user_id:
574 574 # set admin if owner
575 575 p = 'usergroup.admin'
576 576 o = PermOrigin.USERGROUP_OWNER
577 577 else:
578 578 p = perm.Permission.permission_name
579 579
580 580 # if we decide this user isn't inheriting permissions from default
581 581 # user we set him to .none so only explicit permissions work
582 582 if not user_inherit_object_permissions:
583 583 p = 'usergroup.none'
584 584 self.permissions_user_groups[u_k] = p, o
585 585
586 586 def _calculate_repository_permissions(self):
587 587 """
588 588 Repository permissions for the current user.
589 589
590 590 Check if the user is part of user groups for this repository and
591 591 fill in the permission from it. `_choose_permission` decides of which
592 592 permission should be selected based on selected method.
593 593 """
594 594
595 595 # user group for repositories permissions
596 596 user_repo_perms_from_user_group = Permission\
597 597 .get_default_repo_perms_from_user_group(
598 598 self.user_id, self.scope_repo_id)
599 599
600 600 multiple_counter = collections.defaultdict(int)
601 601 for perm in user_repo_perms_from_user_group:
602 602 r_k = perm.UserGroupRepoToPerm.repository.repo_name
603 603 ug_k = perm.UserGroupRepoToPerm.users_group.users_group_name
604 604 multiple_counter[r_k] += 1
605 605 p = perm.Permission.permission_name
606 606 o = PermOrigin.REPO_USERGROUP % ug_k
607 607
608 608 if perm.Repository.user_id == self.user_id:
609 609 # set admin if owner
610 610 p = 'repository.admin'
611 611 o = PermOrigin.REPO_OWNER
612 612 else:
613 613 if multiple_counter[r_k] > 1:
614 614 cur_perm = self.permissions_repositories[r_k]
615 615 p = self._choose_permission(p, cur_perm)
616 616 self.permissions_repositories[r_k] = p, o
617 617
618 618 # user explicit permissions for repositories, overrides any specified
619 619 # by the group permission
620 620 user_repo_perms = Permission.get_default_repo_perms(
621 621 self.user_id, self.scope_repo_id)
622 622 for perm in user_repo_perms:
623 623 r_k = perm.UserRepoToPerm.repository.repo_name
624 624 o = PermOrigin.REPO_USER % perm.UserRepoToPerm.user.username
625 625 # set admin if owner
626 626 if perm.Repository.user_id == self.user_id:
627 627 p = 'repository.admin'
628 628 o = PermOrigin.REPO_OWNER
629 629 else:
630 630 p = perm.Permission.permission_name
631 631 if not self.explicit:
632 632 cur_perm = self.permissions_repositories.get(
633 633 r_k, 'repository.none')
634 634 p = self._choose_permission(p, cur_perm)
635 635 self.permissions_repositories[r_k] = p, o
636 636
637 637 def _calculate_repository_group_permissions(self):
638 638 """
639 639 Repository group permissions for the current user.
640 640
641 641 Check if the user is part of user groups for repository groups and
642 642 fill in the permissions from it. `_choose_permmission` decides of which
643 643 permission should be selected based on selected method.
644 644 """
645 645 # user group for repo groups permissions
646 646 user_repo_group_perms_from_user_group = Permission\
647 647 .get_default_group_perms_from_user_group(
648 648 self.user_id, self.scope_repo_group_id)
649 649
650 650 multiple_counter = collections.defaultdict(int)
651 651 for perm in user_repo_group_perms_from_user_group:
652 652 g_k = perm.UserGroupRepoGroupToPerm.group.group_name
653 653 ug_k = perm.UserGroupRepoGroupToPerm.users_group.users_group_name
654 654 o = PermOrigin.REPOGROUP_USERGROUP % ug_k
655 655 multiple_counter[g_k] += 1
656 656 p = perm.Permission.permission_name
657 657 if perm.RepoGroup.user_id == self.user_id:
658 658 # set admin if owner, even for member of other user group
659 659 p = 'group.admin'
660 660 o = PermOrigin.REPOGROUP_OWNER
661 661 else:
662 662 if multiple_counter[g_k] > 1:
663 663 cur_perm = self.permissions_repository_groups[g_k]
664 664 p = self._choose_permission(p, cur_perm)
665 665 self.permissions_repository_groups[g_k] = p, o
666 666
667 667 # user explicit permissions for repository groups
668 668 user_repo_groups_perms = Permission.get_default_group_perms(
669 669 self.user_id, self.scope_repo_group_id)
670 670 for perm in user_repo_groups_perms:
671 671 rg_k = perm.UserRepoGroupToPerm.group.group_name
672 672 u_k = perm.UserRepoGroupToPerm.user.username
673 673 o = PermOrigin.REPOGROUP_USER % u_k
674 674
675 675 if perm.RepoGroup.user_id == self.user_id:
676 676 # set admin if owner
677 677 p = 'group.admin'
678 678 o = PermOrigin.REPOGROUP_OWNER
679 679 else:
680 680 p = perm.Permission.permission_name
681 681 if not self.explicit:
682 682 cur_perm = self.permissions_repository_groups.get(
683 683 rg_k, 'group.none')
684 684 p = self._choose_permission(p, cur_perm)
685 685 self.permissions_repository_groups[rg_k] = p, o
686 686
687 687 def _calculate_user_group_permissions(self):
688 688 """
689 689 User group permissions for the current user.
690 690 """
691 691 # user group for user group permissions
692 692 user_group_from_user_group = Permission\
693 693 .get_default_user_group_perms_from_user_group(
694 694 self.user_id, self.scope_user_group_id)
695 695
696 696 multiple_counter = collections.defaultdict(int)
697 697 for perm in user_group_from_user_group:
698 698 g_k = perm.UserGroupUserGroupToPerm\
699 699 .target_user_group.users_group_name
700 700 u_k = perm.UserGroupUserGroupToPerm\
701 701 .user_group.users_group_name
702 702 o = PermOrigin.USERGROUP_USERGROUP % u_k
703 703 multiple_counter[g_k] += 1
704 704 p = perm.Permission.permission_name
705 705
706 706 if perm.UserGroup.user_id == self.user_id:
707 707 # set admin if owner, even for member of other user group
708 708 p = 'usergroup.admin'
709 709 o = PermOrigin.USERGROUP_OWNER
710 710 else:
711 711 if multiple_counter[g_k] > 1:
712 712 cur_perm = self.permissions_user_groups[g_k]
713 713 p = self._choose_permission(p, cur_perm)
714 714 self.permissions_user_groups[g_k] = p, o
715 715
716 716 # user explicit permission for user groups
717 717 user_user_groups_perms = Permission.get_default_user_group_perms(
718 718 self.user_id, self.scope_user_group_id)
719 719 for perm in user_user_groups_perms:
720 720 ug_k = perm.UserUserGroupToPerm.user_group.users_group_name
721 721 u_k = perm.UserUserGroupToPerm.user.username
722 722 o = PermOrigin.USERGROUP_USER % u_k
723 723
724 724 if perm.UserGroup.user_id == self.user_id:
725 725 # set admin if owner
726 726 p = 'usergroup.admin'
727 727 o = PermOrigin.USERGROUP_OWNER
728 728 else:
729 729 p = perm.Permission.permission_name
730 730 if not self.explicit:
731 731 cur_perm = self.permissions_user_groups.get(
732 732 ug_k, 'usergroup.none')
733 733 p = self._choose_permission(p, cur_perm)
734 734 self.permissions_user_groups[ug_k] = p, o
735 735
736 736 def _choose_permission(self, new_perm, cur_perm):
737 737 new_perm_val = Permission.PERM_WEIGHTS[new_perm]
738 738 cur_perm_val = Permission.PERM_WEIGHTS[cur_perm]
739 739 if self.algo == 'higherwin':
740 740 if new_perm_val > cur_perm_val:
741 741 return new_perm
742 742 return cur_perm
743 743 elif self.algo == 'lowerwin':
744 744 if new_perm_val < cur_perm_val:
745 745 return new_perm
746 746 return cur_perm
747 747
748 748 def _permission_structure(self):
749 749 return {
750 750 'global': self.permissions_global,
751 751 'repositories': self.permissions_repositories,
752 752 'repositories_groups': self.permissions_repository_groups,
753 753 'user_groups': self.permissions_user_groups,
754 754 }
755 755
756 756
757 757 def allowed_auth_token_access(controller_name, whitelist=None, auth_token=None):
758 758 """
759 759 Check if given controller_name is in whitelist of auth token access
760 760 """
761 761 if not whitelist:
762 762 from rhodecode import CONFIG
763 763 whitelist = aslist(
764 764 CONFIG.get('api_access_controllers_whitelist'), sep=',')
765 765 log.debug(
766 766 'Allowed controllers for AUTH TOKEN access: %s' % (whitelist,))
767 767
768 768 auth_token_access_valid = False
769 769 for entry in whitelist:
770 770 if fnmatch.fnmatch(controller_name, entry):
771 771 auth_token_access_valid = True
772 772 break
773 773
774 774 if auth_token_access_valid:
775 775 log.debug('controller:%s matches entry in whitelist'
776 776 % (controller_name,))
777 777 else:
778 778 msg = ('controller: %s does *NOT* match any entry in whitelist'
779 779 % (controller_name,))
780 780 if auth_token:
781 781 # if we use auth token key and don't have access it's a warning
782 782 log.warning(msg)
783 783 else:
784 784 log.debug(msg)
785 785
786 786 return auth_token_access_valid
787 787
788 788
789 789 class AuthUser(object):
790 790 """
791 791 A simple object that handles all attributes of user in RhodeCode
792 792
793 793 It does lookup based on API key,given user, or user present in session
794 794 Then it fills all required information for such user. It also checks if
795 795 anonymous access is enabled and if so, it returns default user as logged in
796 796 """
797 797 GLOBAL_PERMS = [x[0] for x in Permission.PERMS]
798 798
799 799 def __init__(self, user_id=None, api_key=None, username=None, ip_addr=None):
800 800
801 801 self.user_id = user_id
802 802 self._api_key = api_key
803 803
804 804 self.api_key = None
805 805 self.feed_token = ''
806 806 self.username = username
807 807 self.ip_addr = ip_addr
808 808 self.name = ''
809 809 self.lastname = ''
810 810 self.email = ''
811 811 self.is_authenticated = False
812 812 self.admin = False
813 813 self.inherit_default_permissions = False
814 814 self.password = ''
815 815
816 816 self.anonymous_user = None # propagated on propagate_data
817 817 self.propagate_data()
818 818 self._instance = None
819 819 self._permissions_scoped_cache = {} # used to bind scoped calculation
820 820
821 821 @LazyProperty
822 822 def permissions(self):
823 823 return self.get_perms(user=self, cache=False)
824 824
825 825 def permissions_with_scope(self, scope):
826 826 """
827 827 Call the get_perms function with scoped data. The scope in that function
828 828 narrows the SQL calls to the given ID of objects resulting in fetching
829 829 Just particular permission we want to obtain. If scope is an empty dict
830 830 then it basically narrows the scope to GLOBAL permissions only.
831 831
832 832 :param scope: dict
833 833 """
834 834 if 'repo_name' in scope:
835 835 obj = Repository.get_by_repo_name(scope['repo_name'])
836 836 if obj:
837 837 scope['repo_id'] = obj.repo_id
838 838 _scope = {
839 839 'repo_id': -1,
840 840 'user_group_id': -1,
841 841 'repo_group_id': -1,
842 842 }
843 843 _scope.update(scope)
844 844 cache_key = "_".join(map(safe_str, reduce(lambda a, b: a+b,
845 845 _scope.items())))
846 846 if cache_key not in self._permissions_scoped_cache:
847 847 # store in cache to mimic how the @LazyProperty works,
848 848 # the difference here is that we use the unique key calculated
849 849 # from params and values
850 850 res = self.get_perms(user=self, cache=False, scope=_scope)
851 851 self._permissions_scoped_cache[cache_key] = res
852 852 return self._permissions_scoped_cache[cache_key]
853 853
854 854 def get_instance(self):
855 855 return User.get(self.user_id)
856 856
857 857 def update_lastactivity(self):
858 858 if self.user_id:
859 859 User.get(self.user_id).update_lastactivity()
860 860
861 861 def propagate_data(self):
862 862 """
863 863 Fills in user data and propagates values to this instance. Maps fetched
864 864 user attributes to this class instance attributes
865 865 """
866 866 log.debug('starting data propagation for new potential AuthUser')
867 867 user_model = UserModel()
868 868 anon_user = self.anonymous_user = User.get_default_user(cache=True)
869 869 is_user_loaded = False
870 870
871 871 # lookup by userid
872 872 if self.user_id is not None and self.user_id != anon_user.user_id:
873 873 log.debug('Trying Auth User lookup by USER ID: `%s`' % self.user_id)
874 874 is_user_loaded = user_model.fill_data(self, user_id=self.user_id)
875 875
876 876 # try go get user by api key
877 877 elif self._api_key and self._api_key != anon_user.api_key:
878 878 log.debug('Trying Auth User lookup by API KEY: `%s`' % self._api_key)
879 879 is_user_loaded = user_model.fill_data(self, api_key=self._api_key)
880 880
881 881 # lookup by username
882 882 elif self.username:
883 883 log.debug('Trying Auth User lookup by USER NAME: `%s`' % self.username)
884 884 is_user_loaded = user_model.fill_data(self, username=self.username)
885 885 else:
886 886 log.debug('No data in %s that could been used to log in' % self)
887 887
888 888 if not is_user_loaded:
889 889 log.debug('Failed to load user. Fallback to default user')
890 890 # if we cannot authenticate user try anonymous
891 891 if anon_user.active:
892 892 user_model.fill_data(self, user_id=anon_user.user_id)
893 893 # then we set this user is logged in
894 894 self.is_authenticated = True
895 895 else:
896 896 # in case of disabled anonymous user we reset some of the
897 897 # parameters so such user is "corrupted", skipping the fill_data
898 898 for attr in ['user_id', 'username', 'admin', 'active']:
899 899 setattr(self, attr, None)
900 900 self.is_authenticated = False
901 901
902 902 if not self.username:
903 903 self.username = 'None'
904 904
905 905 log.debug('Auth User is now %s' % self)
906 906
907 907 def get_perms(self, user, scope=None, explicit=True, algo='higherwin',
908 908 cache=False):
909 909 """
910 910 Fills user permission attribute with permissions taken from database
911 911 works for permissions given for repositories, and for permissions that
912 912 are granted to groups
913 913
914 914 :param user: instance of User object from database
915 915 :param explicit: In case there are permissions both for user and a group
916 916 that user is part of, explicit flag will defiine if user will
917 917 explicitly override permissions from group, if it's False it will
918 918 make decision based on the algo
919 919 :param algo: algorithm to decide what permission should be choose if
920 920 it's multiple defined, eg user in two different groups. It also
921 921 decides if explicit flag is turned off how to specify the permission
922 922 for case when user is in a group + have defined separate permission
923 923 """
924 924 user_id = user.user_id
925 925 user_is_admin = user.is_admin
926 926
927 927 # inheritance of global permissions like create repo/fork repo etc
928 928 user_inherit_default_permissions = user.inherit_default_permissions
929 929
930 930 log.debug('Computing PERMISSION tree for scope %s' % (scope, ))
931 931 compute = caches.conditional_cache(
932 932 'short_term', 'cache_desc',
933 933 condition=cache, func=_cached_perms_data)
934 934 result = compute(user_id, scope, user_is_admin,
935 935 user_inherit_default_permissions, explicit, algo)
936 936
937 937 result_repr = []
938 938 for k in result:
939 939 result_repr.append((k, len(result[k])))
940 940
941 941 log.debug('PERMISSION tree computed %s' % (result_repr,))
942 942 return result
943 943
944 944 @property
945 945 def is_default(self):
946 946 return self.username == User.DEFAULT_USER
947 947
948 948 @property
949 949 def is_admin(self):
950 950 return self.admin
951 951
952 952 @property
953 953 def is_user_object(self):
954 954 return self.user_id is not None
955 955
956 956 @property
957 957 def repositories_admin(self):
958 958 """
959 959 Returns list of repositories you're an admin of
960 960 """
961 961 return [
962 962 x[0] for x in self.permissions['repositories'].iteritems()
963 963 if x[1] == 'repository.admin']
964 964
965 965 @property
966 966 def repository_groups_admin(self):
967 967 """
968 968 Returns list of repository groups you're an admin of
969 969 """
970 970 return [
971 971 x[0] for x in self.permissions['repositories_groups'].iteritems()
972 972 if x[1] == 'group.admin']
973 973
974 974 @property
975 975 def user_groups_admin(self):
976 976 """
977 977 Returns list of user groups you're an admin of
978 978 """
979 979 return [
980 980 x[0] for x in self.permissions['user_groups'].iteritems()
981 981 if x[1] == 'usergroup.admin']
982 982
983 983 @property
984 984 def ip_allowed(self):
985 985 """
986 986 Checks if ip_addr used in constructor is allowed from defined list of
987 987 allowed ip_addresses for user
988 988
989 989 :returns: boolean, True if ip is in allowed ip range
990 990 """
991 991 # check IP
992 992 inherit = self.inherit_default_permissions
993 993 return AuthUser.check_ip_allowed(self.user_id, self.ip_addr,
994 994 inherit_from_default=inherit)
995 995 @property
996 996 def personal_repo_group(self):
997 997 return RepoGroup.get_user_personal_repo_group(self.user_id)
998 998
999 999 @classmethod
1000 1000 def check_ip_allowed(cls, user_id, ip_addr, inherit_from_default):
1001 1001 allowed_ips = AuthUser.get_allowed_ips(
1002 1002 user_id, cache=True, inherit_from_default=inherit_from_default)
1003 1003 if check_ip_access(source_ip=ip_addr, allowed_ips=allowed_ips):
1004 1004 log.debug('IP:%s is in range of %s' % (ip_addr, allowed_ips))
1005 1005 return True
1006 1006 else:
1007 1007 log.info('Access for IP:%s forbidden, '
1008 1008 'not in %s' % (ip_addr, allowed_ips))
1009 1009 return False
1010 1010
1011 1011 def __repr__(self):
1012 1012 return "<AuthUser('id:%s[%s] ip:%s auth:%s')>"\
1013 1013 % (self.user_id, self.username, self.ip_addr, self.is_authenticated)
1014 1014
1015 1015 def set_authenticated(self, authenticated=True):
1016 1016 if self.user_id != self.anonymous_user.user_id:
1017 1017 self.is_authenticated = authenticated
1018 1018
1019 1019 def get_cookie_store(self):
1020 1020 return {
1021 1021 'username': self.username,
1022 1022 'password': md5(self.password),
1023 1023 'user_id': self.user_id,
1024 1024 'is_authenticated': self.is_authenticated
1025 1025 }
1026 1026
1027 1027 @classmethod
1028 1028 def from_cookie_store(cls, cookie_store):
1029 1029 """
1030 1030 Creates AuthUser from a cookie store
1031 1031
1032 1032 :param cls:
1033 1033 :param cookie_store:
1034 1034 """
1035 1035 user_id = cookie_store.get('user_id')
1036 1036 username = cookie_store.get('username')
1037 1037 api_key = cookie_store.get('api_key')
1038 1038 return AuthUser(user_id, api_key, username)
1039 1039
1040 1040 @classmethod
1041 1041 def get_allowed_ips(cls, user_id, cache=False, inherit_from_default=False):
1042 1042 _set = set()
1043 1043
1044 1044 if inherit_from_default:
1045 1045 default_ips = UserIpMap.query().filter(
1046 1046 UserIpMap.user == User.get_default_user(cache=True))
1047 1047 if cache:
1048 1048 default_ips = default_ips.options(
1049 1049 FromCache("sql_cache_short", "get_user_ips_default"))
1050 1050
1051 1051 # populate from default user
1052 1052 for ip in default_ips:
1053 1053 try:
1054 1054 _set.add(ip.ip_addr)
1055 1055 except ObjectDeletedError:
1056 1056 # since we use heavy caching sometimes it happens that
1057 1057 # we get deleted objects here, we just skip them
1058 1058 pass
1059 1059
1060 1060 user_ips = UserIpMap.query().filter(UserIpMap.user_id == user_id)
1061 1061 if cache:
1062 1062 user_ips = user_ips.options(
1063 1063 FromCache("sql_cache_short", "get_user_ips_%s" % user_id))
1064 1064
1065 1065 for ip in user_ips:
1066 1066 try:
1067 1067 _set.add(ip.ip_addr)
1068 1068 except ObjectDeletedError:
1069 1069 # since we use heavy caching sometimes it happens that we get
1070 1070 # deleted objects here, we just skip them
1071 1071 pass
1072 1072 return _set or set(['0.0.0.0/0', '::/0'])
1073 1073
1074 1074
1075 1075 def set_available_permissions(config):
1076 1076 """
1077 1077 This function will propagate pylons globals with all available defined
1078 1078 permission given in db. We don't want to check each time from db for new
1079 1079 permissions since adding a new permission also requires application restart
1080 1080 ie. to decorate new views with the newly created permission
1081 1081
1082 1082 :param config: current pylons config instance
1083 1083
1084 1084 """
1085 1085 log.info('getting information about all available permissions')
1086 1086 try:
1087 1087 sa = meta.Session
1088 1088 all_perms = sa.query(Permission).all()
1089 1089 config['available_permissions'] = [x.permission_name for x in all_perms]
1090 1090 except Exception:
1091 1091 log.error(traceback.format_exc())
1092 1092 finally:
1093 1093 meta.Session.remove()
1094 1094
1095 1095
1096 1096 def get_csrf_token(session=None, force_new=False, save_if_missing=True):
1097 1097 """
1098 1098 Return the current authentication token, creating one if one doesn't
1099 1099 already exist and the save_if_missing flag is present.
1100 1100
1101 1101 :param session: pass in the pylons session, else we use the global ones
1102 1102 :param force_new: force to re-generate the token and store it in session
1103 1103 :param save_if_missing: save the newly generated token if it's missing in
1104 1104 session
1105 1105 """
1106 1106 if not session:
1107 1107 from pylons import session
1108 1108
1109 1109 if (csrf_token_key not in session and save_if_missing) or force_new:
1110 1110 token = hashlib.sha1(str(random.getrandbits(128))).hexdigest()
1111 1111 session[csrf_token_key] = token
1112 1112 if hasattr(session, 'save'):
1113 1113 session.save()
1114 1114 return session.get(csrf_token_key)
1115 1115
1116 1116
1117 1117 # CHECK DECORATORS
1118 1118 class CSRFRequired(object):
1119 1119 """
1120 1120 Decorator for authenticating a form
1121 1121
1122 1122 This decorator uses an authorization token stored in the client's
1123 1123 session for prevention of certain Cross-site request forgery (CSRF)
1124 1124 attacks (See
1125 1125 http://en.wikipedia.org/wiki/Cross-site_request_forgery for more
1126 1126 information).
1127 1127
1128 1128 For use with the ``webhelpers.secure_form`` helper functions.
1129 1129
1130 1130 """
1131 1131 def __init__(self, token=csrf_token_key, header='X-CSRF-Token',
1132 1132 except_methods=None):
1133 1133 self.token = token
1134 1134 self.header = header
1135 1135 self.except_methods = except_methods or []
1136 1136
1137 1137 def __call__(self, func):
1138 1138 return get_cython_compat_decorator(self.__wrapper, func)
1139 1139
1140 1140 def _get_csrf(self, _request):
1141 1141 return _request.POST.get(self.token, _request.headers.get(self.header))
1142 1142
1143 1143 def check_csrf(self, _request, cur_token):
1144 1144 supplied_token = self._get_csrf(_request)
1145 1145 return supplied_token and supplied_token == cur_token
1146 1146
1147 1147 def __wrapper(self, func, *fargs, **fkwargs):
1148 1148 if request.method in self.except_methods:
1149 1149 return func(*fargs, **fkwargs)
1150 1150
1151 1151 cur_token = get_csrf_token(save_if_missing=False)
1152 1152 if self.check_csrf(request, cur_token):
1153 1153 if request.POST.get(self.token):
1154 1154 del request.POST[self.token]
1155 1155 return func(*fargs, **fkwargs)
1156 1156 else:
1157 1157 reason = 'token-missing'
1158 1158 supplied_token = self._get_csrf(request)
1159 1159 if supplied_token and cur_token != supplied_token:
1160 1160 reason = 'token-mismatch [%s:%s]' % (cur_token or ''[:6],
1161 1161 supplied_token or ''[:6])
1162 1162
1163 1163 csrf_message = \
1164 1164 ("Cross-site request forgery detected, request denied. See "
1165 1165 "http://en.wikipedia.org/wiki/Cross-site_request_forgery for "
1166 1166 "more information.")
1167 1167 log.warn('Cross-site request forgery detected, request %r DENIED: %s '
1168 1168 'REMOTE_ADDR:%s, HEADERS:%s' % (
1169 1169 request, reason, request.remote_addr, request.headers))
1170 1170
1171 1171 raise HTTPForbidden(explanation=csrf_message)
1172 1172
1173 1173
1174 1174 class LoginRequired(object):
1175 1175 """
1176 1176 Must be logged in to execute this function else
1177 1177 redirect to login page
1178 1178
1179 1179 :param api_access: if enabled this checks only for valid auth token
1180 1180 and grants access based on valid token
1181 1181 """
1182 1182 def __init__(self, auth_token_access=None):
1183 1183 self.auth_token_access = auth_token_access
1184 1184
1185 1185 def __call__(self, func):
1186 1186 return get_cython_compat_decorator(self.__wrapper, func)
1187 1187
1188 def _get_request(self):
1189 from pyramid.threadlocal import get_current_request
1190 pyramid_request = get_current_request()
1191 if not pyramid_request:
1192 # return global request of pylons in case pyramid isn't available
1193 return request
1194 return pyramid_request
1195
1188 1196 def __wrapper(self, func, *fargs, **fkwargs):
1189 1197 from rhodecode.lib import helpers as h
1190 1198 cls = fargs[0]
1191 1199 user = cls._rhodecode_user
1200 request = self._get_request()
1201
1192 1202 loc = "%s:%s" % (cls.__class__.__name__, func.__name__)
1193 1203 log.debug('Starting login restriction checks for user: %s' % (user,))
1194 1204 # check if our IP is allowed
1195 1205 ip_access_valid = True
1196 1206 if not user.ip_allowed:
1197 1207 h.flash(h.literal(_('IP %s not allowed' % (user.ip_addr,))),
1198 1208 category='warning')
1199 1209 ip_access_valid = False
1200 1210
1201 1211 # check if we used an APIKEY and it's a valid one
1202 1212 # defined white-list of controllers which API access will be enabled
1203 1213 _auth_token = request.GET.get(
1204 1214 'auth_token', '') or request.GET.get('api_key', '')
1205 1215 auth_token_access_valid = allowed_auth_token_access(
1206 1216 loc, auth_token=_auth_token)
1207 1217
1208 1218 # explicit controller is enabled or API is in our whitelist
1209 1219 if self.auth_token_access or auth_token_access_valid:
1210 1220 log.debug('Checking AUTH TOKEN access for %s' % (cls,))
1211 1221 db_user = user.get_instance()
1212 1222
1213 1223 if db_user:
1214 1224 if self.auth_token_access:
1215 1225 roles = self.auth_token_access
1216 1226 else:
1217 1227 roles = [UserApiKeys.ROLE_HTTP]
1218 1228 token_match = db_user.authenticate_by_token(
1219 1229 _auth_token, roles=roles)
1220 1230 else:
1221 1231 log.debug('Unable to fetch db instance for auth user: %s', user)
1222 1232 token_match = False
1223 1233
1224 1234 if _auth_token and token_match:
1225 1235 auth_token_access_valid = True
1226 1236 log.debug('AUTH TOKEN ****%s is VALID' % (_auth_token[-4:],))
1227 1237 else:
1228 1238 auth_token_access_valid = False
1229 1239 if not _auth_token:
1230 1240 log.debug("AUTH TOKEN *NOT* present in request")
1231 1241 else:
1232 1242 log.warning(
1233 1243 "AUTH TOKEN ****%s *NOT* valid" % _auth_token[-4:])
1234 1244
1235 1245 log.debug('Checking if %s is authenticated @ %s' % (user.username, loc))
1236 1246 reason = 'RHODECODE_AUTH' if user.is_authenticated \
1237 1247 else 'AUTH_TOKEN_AUTH'
1238 1248
1239 1249 if ip_access_valid and (
1240 1250 user.is_authenticated or auth_token_access_valid):
1241 1251 log.info(
1242 1252 'user %s authenticating with:%s IS authenticated on func %s'
1243 1253 % (user, reason, loc))
1244 1254
1245 1255 # update user data to check last activity
1246 1256 user.update_lastactivity()
1247 1257 Session().commit()
1248 1258 return func(*fargs, **fkwargs)
1249 1259 else:
1250 1260 log.warning(
1251 1261 'user %s authenticating with:%s NOT authenticated on '
1252 1262 'func: %s: IP_ACCESS:%s AUTH_TOKEN_ACCESS:%s'
1253 1263 % (user, reason, loc, ip_access_valid,
1254 1264 auth_token_access_valid))
1255 1265 # we preserve the get PARAM
1256 1266 came_from = request.path_qs
1257 1267 log.debug('redirecting to login page with %s' % (came_from,))
1258 1268 return redirect(
1259 1269 h.route_path('login', _query={'came_from': came_from}))
1260 1270
1261 1271
1262 1272 class NotAnonymous(object):
1263 1273 """
1264 1274 Must be logged in to execute this function else
1265 redirect to login page"""
1275 redirect to login page
1276 """
1266 1277
1267 1278 def __call__(self, func):
1268 1279 return get_cython_compat_decorator(self.__wrapper, func)
1269 1280
1270 1281 def __wrapper(self, func, *fargs, **fkwargs):
1271 1282 import rhodecode.lib.helpers as h
1272 1283 cls = fargs[0]
1273 1284 self.user = cls._rhodecode_user
1274 1285
1275 1286 log.debug('Checking if user is not anonymous @%s' % cls)
1276 1287
1277 1288 anonymous = self.user.username == User.DEFAULT_USER
1278 1289
1279 1290 if anonymous:
1280 1291 came_from = request.path_qs
1281 1292 h.flash(_('You need to be a registered user to '
1282 1293 'perform this action'),
1283 1294 category='warning')
1284 1295 return redirect(
1285 1296 h.route_path('login', _query={'came_from': came_from}))
1286 1297 else:
1287 1298 return func(*fargs, **fkwargs)
1288 1299
1289 1300
1290 1301 class XHRRequired(object):
1302 # TODO(marcink): remove this in favor of the predicates in pyramid routes
1303
1291 1304 def __call__(self, func):
1292 1305 return get_cython_compat_decorator(self.__wrapper, func)
1293 1306
1294 1307 def __wrapper(self, func, *fargs, **fkwargs):
1295 1308 log.debug('Checking if request is XMLHttpRequest (XHR)')
1296 1309 xhr_message = 'This is not a valid XMLHttpRequest (XHR) request'
1297 1310 if not request.is_xhr:
1298 1311 abort(400, detail=xhr_message)
1299 1312
1300 1313 return func(*fargs, **fkwargs)
1301 1314
1302 1315
1303 1316 class HasAcceptedRepoType(object):
1304 1317 """
1305 1318 Check if requested repo is within given repo type aliases
1319 """
1306 1320
1307 TODO: anderson: not sure where to put this decorator
1308 """
1321 # TODO(marcink): remove this in favor of the predicates in pyramid routes
1309 1322
1310 1323 def __init__(self, *repo_type_list):
1311 1324 self.repo_type_list = set(repo_type_list)
1312 1325
1313 1326 def __call__(self, func):
1314 1327 return get_cython_compat_decorator(self.__wrapper, func)
1315 1328
1316 1329 def __wrapper(self, func, *fargs, **fkwargs):
1317 1330 import rhodecode.lib.helpers as h
1318 1331 cls = fargs[0]
1319 1332 rhodecode_repo = cls.rhodecode_repo
1320 1333
1321 1334 log.debug('%s checking repo type for %s in %s',
1322 1335 self.__class__.__name__,
1323 1336 rhodecode_repo.alias, self.repo_type_list)
1324 1337
1325 1338 if rhodecode_repo.alias in self.repo_type_list:
1326 1339 return func(*fargs, **fkwargs)
1327 1340 else:
1328 1341 h.flash(h.literal(
1329 1342 _('Action not supported for %s.' % rhodecode_repo.alias)),
1330 1343 category='warning')
1331 1344 return redirect(
1332 1345 url('summary_home', repo_name=cls.rhodecode_db_repo.repo_name))
1333 1346
1334 1347
1335 1348 class PermsDecorator(object):
1336 1349 """
1337 1350 Base class for controller decorators, we extract the current user from
1338 1351 the class itself, which has it stored in base controllers
1339 1352 """
1340 1353
1341 1354 def __init__(self, *required_perms):
1342 1355 self.required_perms = set(required_perms)
1343 1356
1344 1357 def __call__(self, func):
1345 1358 return get_cython_compat_decorator(self.__wrapper, func)
1346 1359
1347 1360 def _get_request(self):
1348 1361 from pyramid.threadlocal import get_current_request
1349 1362 pyramid_request = get_current_request()
1350 1363 if not pyramid_request:
1351 1364 # return global request of pylons in case pyramid isn't available
1352 1365 return request
1353 1366 return pyramid_request
1354 1367
1355 1368 def _get_came_from(self):
1356 1369 _request = self._get_request()
1357 1370
1358 1371 # both pylons/pyramid has this attribute
1359 1372 return _request.path_qs
1360 1373
1361 1374 def __wrapper(self, func, *fargs, **fkwargs):
1362 1375 import rhodecode.lib.helpers as h
1363 1376 cls = fargs[0]
1364 1377 _user = cls._rhodecode_user
1365 1378
1366 1379 log.debug('checking %s permissions %s for %s %s',
1367 1380 self.__class__.__name__, self.required_perms, cls, _user)
1368 1381
1369 1382 if self.check_permissions(_user):
1370 1383 log.debug('Permission granted for %s %s', cls, _user)
1371 1384 return func(*fargs, **fkwargs)
1372 1385
1373 1386 else:
1374 1387 log.debug('Permission denied for %s %s', cls, _user)
1375 1388 anonymous = _user.username == User.DEFAULT_USER
1376 1389
1377 1390 if anonymous:
1378 1391 came_from = self._get_came_from()
1379 1392 h.flash(_('You need to be signed in to view this page'),
1380 1393 category='warning')
1381 1394 raise HTTPFound(
1382 1395 h.route_path('login', _query={'came_from': came_from}))
1383 1396
1384 1397 else:
1385 1398 # redirect with forbidden ret code
1386 1399 raise HTTPForbidden()
1387 1400
1388 1401 def check_permissions(self, user):
1389 1402 """Dummy function for overriding"""
1390 1403 raise NotImplementedError(
1391 1404 'You have to write this function in child class')
1392 1405
1393 1406
1394 1407 class HasPermissionAllDecorator(PermsDecorator):
1395 1408 """
1396 1409 Checks for access permission for all given predicates. All of them
1397 1410 have to be meet in order to fulfill the request
1398 1411 """
1399 1412
1400 1413 def check_permissions(self, user):
1401 1414 perms = user.permissions_with_scope({})
1402 1415 if self.required_perms.issubset(perms['global']):
1403 1416 return True
1404 1417 return False
1405 1418
1406 1419
1407 1420 class HasPermissionAnyDecorator(PermsDecorator):
1408 1421 """
1409 1422 Checks for access permission for any of given predicates. In order to
1410 1423 fulfill the request any of predicates must be meet
1411 1424 """
1412 1425
1413 1426 def check_permissions(self, user):
1414 1427 perms = user.permissions_with_scope({})
1415 1428 if self.required_perms.intersection(perms['global']):
1416 1429 return True
1417 1430 return False
1418 1431
1419 1432
1420 1433 class HasRepoPermissionAllDecorator(PermsDecorator):
1421 1434 """
1422 1435 Checks for access permission for all given predicates for specific
1423 1436 repository. All of them have to be meet in order to fulfill the request
1424 1437 """
1425 1438 def _get_repo_name(self):
1426 1439 _request = self._get_request()
1427 1440 return get_repo_slug(_request)
1428 1441
1429 1442 def check_permissions(self, user):
1430 1443 perms = user.permissions
1431 1444 repo_name = self._get_repo_name()
1432 1445
1433 1446 try:
1434 1447 user_perms = set([perms['repositories'][repo_name]])
1435 1448 except KeyError:
1436 1449 log.debug('cannot locate repo with name: `%s` in permissions defs',
1437 1450 repo_name)
1438 1451 return False
1439 1452
1440 1453 log.debug('checking `%s` permissions for repo `%s`',
1441 1454 user_perms, repo_name)
1442 1455 if self.required_perms.issubset(user_perms):
1443 1456 return True
1444 1457 return False
1445 1458
1446 1459
1447 1460 class HasRepoPermissionAnyDecorator(PermsDecorator):
1448 1461 """
1449 1462 Checks for access permission for any of given predicates for specific
1450 1463 repository. In order to fulfill the request any of predicates must be meet
1451 1464 """
1452 1465 def _get_repo_name(self):
1453 1466 _request = self._get_request()
1454 1467 return get_repo_slug(_request)
1455 1468
1456 1469 def check_permissions(self, user):
1457 1470 perms = user.permissions
1458 1471 repo_name = self._get_repo_name()
1459 1472
1460 1473 try:
1461 1474 user_perms = set([perms['repositories'][repo_name]])
1462 1475 except KeyError:
1463 1476 log.debug('cannot locate repo with name: `%s` in permissions defs',
1464 1477 repo_name)
1465 1478 return False
1466 1479
1467 1480 log.debug('checking `%s` permissions for repo `%s`',
1468 1481 user_perms, repo_name)
1469 1482 if self.required_perms.intersection(user_perms):
1470 1483 return True
1471 1484 return False
1472 1485
1473 1486
1474 1487 class HasRepoGroupPermissionAllDecorator(PermsDecorator):
1475 1488 """
1476 1489 Checks for access permission for all given predicates for specific
1477 1490 repository group. All of them have to be meet in order to
1478 1491 fulfill the request
1479 1492 """
1480 1493 def _get_repo_group_name(self):
1481 1494 _request = self._get_request()
1482 1495 return get_repo_group_slug(_request)
1483 1496
1484 1497 def check_permissions(self, user):
1485 1498 perms = user.permissions
1486 1499 group_name = self._get_repo_group_name()
1487 1500 try:
1488 1501 user_perms = set([perms['repositories_groups'][group_name]])
1489 1502 except KeyError:
1490 1503 log.debug('cannot locate repo group with name: `%s` in permissions defs',
1491 1504 group_name)
1492 1505 return False
1493 1506
1494 1507 log.debug('checking `%s` permissions for repo group `%s`',
1495 1508 user_perms, group_name)
1496 1509 if self.required_perms.issubset(user_perms):
1497 1510 return True
1498 1511 return False
1499 1512
1500 1513
1501 1514 class HasRepoGroupPermissionAnyDecorator(PermsDecorator):
1502 1515 """
1503 1516 Checks for access permission for any of given predicates for specific
1504 1517 repository group. In order to fulfill the request any
1505 1518 of predicates must be met
1506 1519 """
1507 1520 def _get_repo_group_name(self):
1508 1521 _request = self._get_request()
1509 1522 return get_repo_group_slug(_request)
1510 1523
1511 1524 def check_permissions(self, user):
1512 1525 perms = user.permissions
1513 1526 group_name = self._get_repo_group_name()
1514 1527
1515 1528 try:
1516 1529 user_perms = set([perms['repositories_groups'][group_name]])
1517 1530 except KeyError:
1518 1531 log.debug('cannot locate repo group with name: `%s` in permissions defs',
1519 1532 group_name)
1520 1533 return False
1521 1534
1522 1535 log.debug('checking `%s` permissions for repo group `%s`',
1523 1536 user_perms, group_name)
1524 1537 if self.required_perms.intersection(user_perms):
1525 1538 return True
1526 1539 return False
1527 1540
1528 1541
1529 1542 class HasUserGroupPermissionAllDecorator(PermsDecorator):
1530 1543 """
1531 1544 Checks for access permission for all given predicates for specific
1532 1545 user group. All of them have to be meet in order to fulfill the request
1533 1546 """
1534 1547 def _get_user_group_name(self):
1535 1548 _request = self._get_request()
1536 1549 return get_user_group_slug(_request)
1537 1550
1538 1551 def check_permissions(self, user):
1539 1552 perms = user.permissions
1540 1553 group_name = self._get_user_group_name()
1541 1554 try:
1542 1555 user_perms = set([perms['user_groups'][group_name]])
1543 1556 except KeyError:
1544 1557 return False
1545 1558
1546 1559 if self.required_perms.issubset(user_perms):
1547 1560 return True
1548 1561 return False
1549 1562
1550 1563
1551 1564 class HasUserGroupPermissionAnyDecorator(PermsDecorator):
1552 1565 """
1553 1566 Checks for access permission for any of given predicates for specific
1554 1567 user group. In order to fulfill the request any of predicates must be meet
1555 1568 """
1556 1569 def _get_user_group_name(self):
1557 1570 _request = self._get_request()
1558 1571 return get_user_group_slug(_request)
1559 1572
1560 1573 def check_permissions(self, user):
1561 1574 perms = user.permissions
1562 1575 group_name = self._get_user_group_name()
1563 1576 try:
1564 1577 user_perms = set([perms['user_groups'][group_name]])
1565 1578 except KeyError:
1566 1579 return False
1567 1580
1568 1581 if self.required_perms.intersection(user_perms):
1569 1582 return True
1570 1583 return False
1571 1584
1572 1585
1573 1586 # CHECK FUNCTIONS
1574 1587 class PermsFunction(object):
1575 1588 """Base function for other check functions"""
1576 1589
1577 1590 def __init__(self, *perms):
1578 1591 self.required_perms = set(perms)
1579 1592 self.repo_name = None
1580 1593 self.repo_group_name = None
1581 1594 self.user_group_name = None
1582 1595
1583 1596 def __bool__(self):
1584 1597 frame = inspect.currentframe()
1585 1598 stack_trace = traceback.format_stack(frame)
1586 1599 log.error('Checking bool value on a class instance of perm '
1587 1600 'function is not allowed: %s' % ''.join(stack_trace))
1588 1601 # rather than throwing errors, here we always return False so if by
1589 1602 # accident someone checks truth for just an instance it will always end
1590 1603 # up in returning False
1591 1604 return False
1592 1605 __nonzero__ = __bool__
1593 1606
1594 1607 def __call__(self, check_location='', user=None):
1595 1608 if not user:
1596 1609 log.debug('Using user attribute from global request')
1597 1610 # TODO: remove this someday,put as user as attribute here
1611 request = self._get_request()
1598 1612 user = request.user
1599 1613
1600 1614 # init auth user if not already given
1601 1615 if not isinstance(user, AuthUser):
1602 1616 log.debug('Wrapping user %s into AuthUser', user)
1603 1617 user = AuthUser(user.user_id)
1604 1618
1605 1619 cls_name = self.__class__.__name__
1606 1620 check_scope = self._get_check_scope(cls_name)
1607 1621 check_location = check_location or 'unspecified location'
1608 1622
1609 1623 log.debug('checking cls:%s %s usr:%s %s @ %s', cls_name,
1610 1624 self.required_perms, user, check_scope, check_location)
1611 1625 if not user:
1612 1626 log.warning('Empty user given for permission check')
1613 1627 return False
1614 1628
1615 1629 if self.check_permissions(user):
1616 1630 log.debug('Permission to repo:`%s` GRANTED for user:`%s` @ %s',
1617 1631 check_scope, user, check_location)
1618 1632 return True
1619 1633
1620 1634 else:
1621 1635 log.debug('Permission to repo:`%s` DENIED for user:`%s` @ %s',
1622 1636 check_scope, user, check_location)
1623 1637 return False
1624 1638
1625 1639 def _get_request(self):
1626 1640 from pyramid.threadlocal import get_current_request
1627 1641 pyramid_request = get_current_request()
1628 1642 if not pyramid_request:
1629 1643 # return global request of pylons incase pyramid one isn't available
1630 1644 return request
1631 1645 return pyramid_request
1632 1646
1633 1647 def _get_check_scope(self, cls_name):
1634 1648 return {
1635 1649 'HasPermissionAll': 'GLOBAL',
1636 1650 'HasPermissionAny': 'GLOBAL',
1637 1651 'HasRepoPermissionAll': 'repo:%s' % self.repo_name,
1638 1652 'HasRepoPermissionAny': 'repo:%s' % self.repo_name,
1639 1653 'HasRepoGroupPermissionAll': 'repo_group:%s' % self.repo_group_name,
1640 1654 'HasRepoGroupPermissionAny': 'repo_group:%s' % self.repo_group_name,
1641 1655 'HasUserGroupPermissionAll': 'user_group:%s' % self.user_group_name,
1642 1656 'HasUserGroupPermissionAny': 'user_group:%s' % self.user_group_name,
1643 1657 }.get(cls_name, '?:%s' % cls_name)
1644 1658
1645 1659 def check_permissions(self, user):
1646 1660 """Dummy function for overriding"""
1647 1661 raise Exception('You have to write this function in child class')
1648 1662
1649 1663
1650 1664 class HasPermissionAll(PermsFunction):
1651 1665 def check_permissions(self, user):
1652 1666 perms = user.permissions_with_scope({})
1653 1667 if self.required_perms.issubset(perms.get('global')):
1654 1668 return True
1655 1669 return False
1656 1670
1657 1671
1658 1672 class HasPermissionAny(PermsFunction):
1659 1673 def check_permissions(self, user):
1660 1674 perms = user.permissions_with_scope({})
1661 1675 if self.required_perms.intersection(perms.get('global')):
1662 1676 return True
1663 1677 return False
1664 1678
1665 1679
1666 1680 class HasRepoPermissionAll(PermsFunction):
1667 1681 def __call__(self, repo_name=None, check_location='', user=None):
1668 1682 self.repo_name = repo_name
1669 1683 return super(HasRepoPermissionAll, self).__call__(check_location, user)
1670 1684
1671 1685 def _get_repo_name(self):
1672 1686 if not self.repo_name:
1673 1687 _request = self._get_request()
1674 1688 self.repo_name = get_repo_slug(_request)
1675 1689 return self.repo_name
1676 1690
1677 1691 def check_permissions(self, user):
1678 1692 self.repo_name = self._get_repo_name()
1679 1693 perms = user.permissions
1680 1694 try:
1681 1695 user_perms = set([perms['repositories'][self.repo_name]])
1682 1696 except KeyError:
1683 1697 return False
1684 1698 if self.required_perms.issubset(user_perms):
1685 1699 return True
1686 1700 return False
1687 1701
1688 1702
1689 1703 class HasRepoPermissionAny(PermsFunction):
1690 1704 def __call__(self, repo_name=None, check_location='', user=None):
1691 1705 self.repo_name = repo_name
1692 1706 return super(HasRepoPermissionAny, self).__call__(check_location, user)
1693 1707
1694 1708 def _get_repo_name(self):
1695 1709 if not self.repo_name:
1696 1710 self.repo_name = get_repo_slug(request)
1697 1711 return self.repo_name
1698 1712
1699 1713 def check_permissions(self, user):
1700 1714 self.repo_name = self._get_repo_name()
1701 1715 perms = user.permissions
1702 1716 try:
1703 1717 user_perms = set([perms['repositories'][self.repo_name]])
1704 1718 except KeyError:
1705 1719 return False
1706 1720 if self.required_perms.intersection(user_perms):
1707 1721 return True
1708 1722 return False
1709 1723
1710 1724
1711 1725 class HasRepoGroupPermissionAny(PermsFunction):
1712 1726 def __call__(self, group_name=None, check_location='', user=None):
1713 1727 self.repo_group_name = group_name
1714 1728 return super(HasRepoGroupPermissionAny, self).__call__(
1715 1729 check_location, user)
1716 1730
1717 1731 def check_permissions(self, user):
1718 1732 perms = user.permissions
1719 1733 try:
1720 1734 user_perms = set(
1721 1735 [perms['repositories_groups'][self.repo_group_name]])
1722 1736 except KeyError:
1723 1737 return False
1724 1738 if self.required_perms.intersection(user_perms):
1725 1739 return True
1726 1740 return False
1727 1741
1728 1742
1729 1743 class HasRepoGroupPermissionAll(PermsFunction):
1730 1744 def __call__(self, group_name=None, check_location='', user=None):
1731 1745 self.repo_group_name = group_name
1732 1746 return super(HasRepoGroupPermissionAll, self).__call__(
1733 1747 check_location, user)
1734 1748
1735 1749 def check_permissions(self, user):
1736 1750 perms = user.permissions
1737 1751 try:
1738 1752 user_perms = set(
1739 1753 [perms['repositories_groups'][self.repo_group_name]])
1740 1754 except KeyError:
1741 1755 return False
1742 1756 if self.required_perms.issubset(user_perms):
1743 1757 return True
1744 1758 return False
1745 1759
1746 1760
1747 1761 class HasUserGroupPermissionAny(PermsFunction):
1748 1762 def __call__(self, user_group_name=None, check_location='', user=None):
1749 1763 self.user_group_name = user_group_name
1750 1764 return super(HasUserGroupPermissionAny, self).__call__(
1751 1765 check_location, user)
1752 1766
1753 1767 def check_permissions(self, user):
1754 1768 perms = user.permissions
1755 1769 try:
1756 1770 user_perms = set([perms['user_groups'][self.user_group_name]])
1757 1771 except KeyError:
1758 1772 return False
1759 1773 if self.required_perms.intersection(user_perms):
1760 1774 return True
1761 1775 return False
1762 1776
1763 1777
1764 1778 class HasUserGroupPermissionAll(PermsFunction):
1765 1779 def __call__(self, user_group_name=None, check_location='', user=None):
1766 1780 self.user_group_name = user_group_name
1767 1781 return super(HasUserGroupPermissionAll, self).__call__(
1768 1782 check_location, user)
1769 1783
1770 1784 def check_permissions(self, user):
1771 1785 perms = user.permissions
1772 1786 try:
1773 1787 user_perms = set([perms['user_groups'][self.user_group_name]])
1774 1788 except KeyError:
1775 1789 return False
1776 1790 if self.required_perms.issubset(user_perms):
1777 1791 return True
1778 1792 return False
1779 1793
1780 1794
1781 1795 # SPECIAL VERSION TO HANDLE MIDDLEWARE AUTH
1782 1796 class HasPermissionAnyMiddleware(object):
1783 1797 def __init__(self, *perms):
1784 1798 self.required_perms = set(perms)
1785 1799
1786 1800 def __call__(self, user, repo_name):
1787 1801 # repo_name MUST be unicode, since we handle keys in permission
1788 1802 # dict by unicode
1789 1803 repo_name = safe_unicode(repo_name)
1790 1804 user = AuthUser(user.user_id)
1791 1805 log.debug(
1792 1806 'Checking VCS protocol permissions %s for user:%s repo:`%s`',
1793 1807 self.required_perms, user, repo_name)
1794 1808
1795 1809 if self.check_permissions(user, repo_name):
1796 1810 log.debug('Permission to repo:`%s` GRANTED for user:%s @ %s',
1797 1811 repo_name, user, 'PermissionMiddleware')
1798 1812 return True
1799 1813
1800 1814 else:
1801 1815 log.debug('Permission to repo:`%s` DENIED for user:%s @ %s',
1802 1816 repo_name, user, 'PermissionMiddleware')
1803 1817 return False
1804 1818
1805 1819 def check_permissions(self, user, repo_name):
1806 1820 perms = user.permissions_with_scope({'repo_name': repo_name})
1807 1821
1808 1822 try:
1809 1823 user_perms = set([perms['repositories'][repo_name]])
1810 1824 except Exception:
1811 1825 log.exception('Error while accessing user permissions')
1812 1826 return False
1813 1827
1814 1828 if self.required_perms.intersection(user_perms):
1815 1829 return True
1816 1830 return False
1817 1831
1818 1832
1819 1833 # SPECIAL VERSION TO HANDLE API AUTH
1820 1834 class _BaseApiPerm(object):
1821 1835 def __init__(self, *perms):
1822 1836 self.required_perms = set(perms)
1823 1837
1824 1838 def __call__(self, check_location=None, user=None, repo_name=None,
1825 1839 group_name=None, user_group_name=None):
1826 1840 cls_name = self.__class__.__name__
1827 1841 check_scope = 'global:%s' % (self.required_perms,)
1828 1842 if repo_name:
1829 1843 check_scope += ', repo_name:%s' % (repo_name,)
1830 1844
1831 1845 if group_name:
1832 1846 check_scope += ', repo_group_name:%s' % (group_name,)
1833 1847
1834 1848 if user_group_name:
1835 1849 check_scope += ', user_group_name:%s' % (user_group_name,)
1836 1850
1837 1851 log.debug(
1838 1852 'checking cls:%s %s %s @ %s'
1839 1853 % (cls_name, self.required_perms, check_scope, check_location))
1840 1854 if not user:
1841 1855 log.debug('Empty User passed into arguments')
1842 1856 return False
1843 1857
1844 1858 # process user
1845 1859 if not isinstance(user, AuthUser):
1846 1860 user = AuthUser(user.user_id)
1847 1861 if not check_location:
1848 1862 check_location = 'unspecified'
1849 1863 if self.check_permissions(user.permissions, repo_name, group_name,
1850 1864 user_group_name):
1851 1865 log.debug('Permission to repo:`%s` GRANTED for user:`%s` @ %s',
1852 1866 check_scope, user, check_location)
1853 1867 return True
1854 1868
1855 1869 else:
1856 1870 log.debug('Permission to repo:`%s` DENIED for user:`%s` @ %s',
1857 1871 check_scope, user, check_location)
1858 1872 return False
1859 1873
1860 1874 def check_permissions(self, perm_defs, repo_name=None, group_name=None,
1861 1875 user_group_name=None):
1862 1876 """
1863 1877 implement in child class should return True if permissions are ok,
1864 1878 False otherwise
1865 1879
1866 1880 :param perm_defs: dict with permission definitions
1867 1881 :param repo_name: repo name
1868 1882 """
1869 1883 raise NotImplementedError()
1870 1884
1871 1885
1872 1886 class HasPermissionAllApi(_BaseApiPerm):
1873 1887 def check_permissions(self, perm_defs, repo_name=None, group_name=None,
1874 1888 user_group_name=None):
1875 1889 if self.required_perms.issubset(perm_defs.get('global')):
1876 1890 return True
1877 1891 return False
1878 1892
1879 1893
1880 1894 class HasPermissionAnyApi(_BaseApiPerm):
1881 1895 def check_permissions(self, perm_defs, repo_name=None, group_name=None,
1882 1896 user_group_name=None):
1883 1897 if self.required_perms.intersection(perm_defs.get('global')):
1884 1898 return True
1885 1899 return False
1886 1900
1887 1901
1888 1902 class HasRepoPermissionAllApi(_BaseApiPerm):
1889 1903 def check_permissions(self, perm_defs, repo_name=None, group_name=None,
1890 1904 user_group_name=None):
1891 1905 try:
1892 1906 _user_perms = set([perm_defs['repositories'][repo_name]])
1893 1907 except KeyError:
1894 1908 log.warning(traceback.format_exc())
1895 1909 return False
1896 1910 if self.required_perms.issubset(_user_perms):
1897 1911 return True
1898 1912 return False
1899 1913
1900 1914
1901 1915 class HasRepoPermissionAnyApi(_BaseApiPerm):
1902 1916 def check_permissions(self, perm_defs, repo_name=None, group_name=None,
1903 1917 user_group_name=None):
1904 1918 try:
1905 1919 _user_perms = set([perm_defs['repositories'][repo_name]])
1906 1920 except KeyError:
1907 1921 log.warning(traceback.format_exc())
1908 1922 return False
1909 1923 if self.required_perms.intersection(_user_perms):
1910 1924 return True
1911 1925 return False
1912 1926
1913 1927
1914 1928 class HasRepoGroupPermissionAnyApi(_BaseApiPerm):
1915 1929 def check_permissions(self, perm_defs, repo_name=None, group_name=None,
1916 1930 user_group_name=None):
1917 1931 try:
1918 1932 _user_perms = set([perm_defs['repositories_groups'][group_name]])
1919 1933 except KeyError:
1920 1934 log.warning(traceback.format_exc())
1921 1935 return False
1922 1936 if self.required_perms.intersection(_user_perms):
1923 1937 return True
1924 1938 return False
1925 1939
1926 1940
1927 1941 class HasRepoGroupPermissionAllApi(_BaseApiPerm):
1928 1942 def check_permissions(self, perm_defs, repo_name=None, group_name=None,
1929 1943 user_group_name=None):
1930 1944 try:
1931 1945 _user_perms = set([perm_defs['repositories_groups'][group_name]])
1932 1946 except KeyError:
1933 1947 log.warning(traceback.format_exc())
1934 1948 return False
1935 1949 if self.required_perms.issubset(_user_perms):
1936 1950 return True
1937 1951 return False
1938 1952
1939 1953
1940 1954 class HasUserGroupPermissionAnyApi(_BaseApiPerm):
1941 1955 def check_permissions(self, perm_defs, repo_name=None, group_name=None,
1942 1956 user_group_name=None):
1943 1957 try:
1944 1958 _user_perms = set([perm_defs['user_groups'][user_group_name]])
1945 1959 except KeyError:
1946 1960 log.warning(traceback.format_exc())
1947 1961 return False
1948 1962 if self.required_perms.intersection(_user_perms):
1949 1963 return True
1950 1964 return False
1951 1965
1952 1966
1953 1967 def check_ip_access(source_ip, allowed_ips=None):
1954 1968 """
1955 1969 Checks if source_ip is a subnet of any of allowed_ips.
1956 1970
1957 1971 :param source_ip:
1958 1972 :param allowed_ips: list of allowed ips together with mask
1959 1973 """
1960 1974 log.debug('checking if ip:%s is subnet of %s' % (source_ip, allowed_ips))
1961 1975 source_ip_address = ipaddress.ip_address(source_ip)
1962 1976 if isinstance(allowed_ips, (tuple, list, set)):
1963 1977 for ip in allowed_ips:
1964 1978 try:
1965 1979 network_address = ipaddress.ip_network(ip, strict=False)
1966 1980 if source_ip_address in network_address:
1967 1981 log.debug('IP %s is network %s' %
1968 1982 (source_ip_address, network_address))
1969 1983 return True
1970 1984 # for any case we cannot determine the IP, don't crash just
1971 1985 # skip it and log as error, we want to say forbidden still when
1972 1986 # sending bad IP
1973 1987 except Exception:
1974 1988 log.error(traceback.format_exc())
1975 1989 continue
1976 1990 return False
1977 1991
1978 1992
1979 1993 def get_cython_compat_decorator(wrapper, func):
1980 1994 """
1981 1995 Creates a cython compatible decorator. The previously used
1982 1996 decorator.decorator() function seems to be incompatible with cython.
1983 1997
1984 1998 :param wrapper: __wrapper method of the decorator class
1985 1999 :param func: decorated function
1986 2000 """
1987 2001 @wraps(func)
1988 2002 def local_wrapper(*args, **kwds):
1989 2003 return wrapper(func, *args, **kwds)
1990 2004 local_wrapper.__wrapped__ = func
1991 2005 return local_wrapper
1992 2006
1993 2007
General Comments 0
You need to be logged in to leave comments. Login now