-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from edx/cpappas/ENT-1557
ENT-1557 | Updating utils files with helper methods
- Loading branch information
Showing
16 changed files
with
513 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| # -*- coding: utf-8 -*- | ||
| """ | ||
| Utils for 'edx-rbac' module. | ||
| """ | ||
| from __future__ import absolute_import, unicode_literals | ||
|
|
||
| import crum | ||
| from django.apps import apps | ||
| from django.conf import settings | ||
| from django.test.client import RequestFactory | ||
| from edx_rest_framework_extensions.auth.jwt.cookies import jwt_cookie_name | ||
| from edx_rest_framework_extensions.auth.jwt.decoder import jwt_decode_handler | ||
| from six.moves.urllib.parse import urlparse # pylint: disable=import-error | ||
|
|
||
|
|
||
| # Taken from edx-platform | ||
| def get_request_or_stub(): | ||
| """ | ||
| Return the current request or a stub request. | ||
| If called outside the context of a request, construct a fake | ||
| request that can be used to build an absolute URI. | ||
| This is useful in cases where we need to pass in a request object | ||
| but don't have an active request (for example, in tests, celery tasks, and XBlocks). | ||
| """ | ||
| request = crum.get_current_request() | ||
|
|
||
| if request is None: | ||
|
|
||
| # The settings SITE_NAME may contain a port number, so we need to | ||
| # parse the full URL. | ||
| full_url = "http://{site_name}".format(site_name=settings.SITE_NAME) | ||
| parsed_url = urlparse(full_url) | ||
|
|
||
| # Construct the fake request. This can be used to construct absolute | ||
| # URIs to other paths. | ||
| return RequestFactory( | ||
| SERVER_NAME=parsed_url.hostname, | ||
| SERVER_PORT=parsed_url.port or 80, | ||
| ).get("/") | ||
|
|
||
| else: | ||
| return request | ||
|
|
||
|
|
||
| def get_decoded_jwt_from_request(request): | ||
| """ | ||
| Grab jwt from request if possible. | ||
| Returns a decoded jwt dict if it finds it. | ||
| Returns a None if it does not. | ||
| """ | ||
| jwt_cookie = request.COOKIES.get(jwt_cookie_name(), None) | ||
|
|
||
| if not jwt_cookie: | ||
| return None | ||
| return jwt_decode_handler(jwt_cookie) | ||
|
|
||
|
|
||
| def request_user_has_implicit_access_via_jwt(decoded_jwt, role_name): | ||
| """ | ||
| Check the request's user access by mapping user's roles found in jwt to local feature roles. | ||
| decoded_jwt is a dict | ||
| role_name is a string | ||
| Returns a boolean. | ||
| Mapping should be in settings and look like: | ||
| SYSTEM_TO_FEATURE_ROLE_MAPPING = { | ||
| 'enterprise_admin': ['coupon-management', 'data_api_access'], | ||
| 'enterprise_leaner': [], | ||
| 'coupon-manager': ['coupon-management'] | ||
| } | ||
| """ | ||
| jwt_roles_claim = decoded_jwt.get('roles', []) | ||
|
|
||
| feature_roles = [] | ||
| for role_data in jwt_roles_claim: | ||
| role_in_jwt = role_data.split(':')[0] # split should be more robust because of our cousekeys having colons | ||
| mapped_roles = settings.SYSTEM_TO_FEATURE_ROLE_MAPPING.get(role_in_jwt, []) | ||
| feature_roles.extend(mapped_roles) | ||
|
|
||
| if role_name in feature_roles: | ||
| return True | ||
| return False | ||
|
|
||
|
|
||
| def user_has_access_via_database(user, role_name, role_assignment_class): | ||
| """ | ||
| Check if there is a role assignment for a given user and role. | ||
| The role object itself is found via the role_name | ||
| """ | ||
| try: | ||
| role_assignment_class.objects.get(user=user, role__name=role_name) | ||
| except role_assignment_class.DoesNotExist: | ||
| return False | ||
| return True | ||
|
|
||
|
|
||
| def create_role_auth_claim_for_user(user): | ||
| """ | ||
| Create role auth claim for a given user. | ||
| Takes a user, and for each RoleAssignment class specified in config as a | ||
| system wide jwt role associated with that user, creates a list of strings | ||
| denoting the role and context. | ||
| Returns a list. | ||
| This setting is a list of classes whose roles should be added to the | ||
| jwt. The setting should look something like this: | ||
| SYSTEM_WIDE_ROLE_CLASSES = [ | ||
| SystemWideConcreteUserRoleAssignment | ||
| ] | ||
| """ | ||
| role_auth_claim = [] | ||
| for system_role_class in settings.SYSTEM_WIDE_ROLE_CLASSES: | ||
| app_name, model_name = system_role_class.split('.') | ||
| model_class = apps.get_model(app_name, model_name) | ||
|
|
||
| role_assignments = model_class.objects.filter( | ||
| user=user | ||
| ).select_related('role') | ||
|
|
||
| for role_assignment in role_assignments: | ||
| role_string = role_assignment.role.name | ||
| context = role_assignment.get_context() | ||
| if context: | ||
| role_string += ':{}'.format(context) | ||
| role_auth_claim.append(role_string) | ||
| return role_auth_claim |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.