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