8555630df7
* Upgrade edx-submissions * Upgrade edx-ora2 * Upgrade edx-val * Upgrade edx-proctoring * Update all edx-platform code that depends on DRF, including: - auth_exchange - cors_csrf - embargo - enrollment - util - commerce - course_structure - discussion_api - mobile_api - notifier_api - teams - credit - profile_images - user_api - lib/api (OAuth2 and pagination)
84 lines
3.4 KiB
Python
84 lines
3.4 KiB
Python
""" Common Authentication Handlers used across projects. """
|
|
from rest_framework.authentication import SessionAuthentication
|
|
from rest_framework_oauth.authentication import OAuth2Authentication
|
|
from rest_framework.exceptions import AuthenticationFailed
|
|
from rest_framework_oauth.compat import oauth2_provider, provider_now
|
|
|
|
|
|
class SessionAuthenticationAllowInactiveUser(SessionAuthentication):
|
|
"""Ensure that the user is logged in, but do not require the account to be active.
|
|
|
|
We use this in the special case that a user has created an account,
|
|
but has not yet activated it. We still want to allow the user to
|
|
enroll in courses, so we remove the usual restriction
|
|
on session authentication that requires an active account.
|
|
|
|
You should use this authentication class ONLY for end-points that
|
|
it's safe for an un-activated user to access. For example,
|
|
we can allow a user to update his/her own enrollments without
|
|
activating an account.
|
|
|
|
"""
|
|
def authenticate(self, request):
|
|
"""Authenticate the user, requiring a logged-in account and CSRF.
|
|
|
|
This is exactly the same as the `SessionAuthentication` implementation,
|
|
with the `user.is_active` check removed.
|
|
|
|
Args:
|
|
request (HttpRequest)
|
|
|
|
Returns:
|
|
Tuple of `(user, token)`
|
|
|
|
Raises:
|
|
PermissionDenied: The CSRF token check failed.
|
|
|
|
"""
|
|
# Get the underlying HttpRequest object
|
|
request = request._request # pylint: disable=protected-access
|
|
user = getattr(request, 'user', None)
|
|
|
|
# Unauthenticated, CSRF validation not required
|
|
# This is where regular `SessionAuthentication` checks that the user is active.
|
|
# We have removed that check in this implementation.
|
|
# But we added a check to prevent anonymous users since we require a logged-in account.
|
|
if not user or user.is_anonymous():
|
|
return None
|
|
|
|
self.enforce_csrf(request)
|
|
|
|
# CSRF passed with authenticated user
|
|
return (user, None)
|
|
|
|
|
|
class OAuth2AuthenticationAllowInactiveUser(OAuth2Authentication):
|
|
"""
|
|
This is a temporary workaround while the is_active field on the user is coupled
|
|
with whether or not the user has verified ownership of their claimed email address.
|
|
Once is_active is decoupled from verified_email, we will no longer need this
|
|
class override.
|
|
|
|
But until then, this authentication class ensures that the user is logged in,
|
|
but does not require that their account "is_active".
|
|
|
|
This class can be used for an OAuth2-accessible endpoint that allows users to access
|
|
that endpoint without having their email verified. For example, this is used
|
|
for mobile endpoints.
|
|
|
|
"""
|
|
def authenticate_credentials(self, request, access_token):
|
|
"""
|
|
Authenticate the request, given the access token.
|
|
Override base class implementation to discard failure if user is inactive.
|
|
"""
|
|
try:
|
|
token = oauth2_provider.oauth2.models.AccessToken.objects.select_related('user')
|
|
# provider_now switches to timezone aware datetime when
|
|
# the oauth2_provider version supports to it.
|
|
token = token.get(token=access_token, expires__gt=provider_now())
|
|
except oauth2_provider.oauth2.models.AccessToken.DoesNotExist:
|
|
raise AuthenticationFailed('Invalid token')
|
|
|
|
return token.user, token
|