"""Provides Authentication and Authorization classes.""" from __future__ import annotations import time from abc import ABC, abstractmethod from typing import TYPE_CHECKING, Any, cast from requests import Request from requests.status_codes import codes from prawcore import const from prawcore.exceptions import InvalidInvocation, OAuthException, ResponseException if TYPE_CHECKING: from collections.abc import Callable from requests.models import Response from prawcore.requestor import Requestor class BaseAuthenticator(ABC): """Provide the base authenticator object that stores OAuth2 credentials.""" @abstractmethod def _auth(self) -> tuple[str, str]: pass @property def requestor(self) -> Requestor: """Return the :class:`.Requestor` used to issue HTTP requests.""" return self._requestor def __init__( self, *, client_id: str, redirect_uri: str | None = None, requestor: Requestor, ) -> None: """Represent a single authentication to Reddit's API. :param client_id: The OAuth2 client ID to use with the session. :param redirect_uri: The redirect URI exactly as specified in your OAuth application settings on Reddit. This parameter is required if you want to use the :meth:`~.Authorizer.authorize_url` method, or the :meth:`~.Authorizer.authorize` method of the :class:`.Authorizer` class (default: ``None``). :param requestor: An instance of :class:`.Requestor`. """ self._requestor = requestor self.client_id = client_id self.redirect_uri = redirect_uri def _post(self, *, url: str, **data: Any) -> Response: response = self._requestor.request( "post", url, auth=self._auth(), data=sorted(data.items()), headers={"Connection": "close"}, ) if response.status_code != codes["ok"]: raise ResponseException(response) return response def authorize_url(self, *, duration: str, implicit: bool = False, scopes: list[str], state: str) -> str: """Return the URL used out-of-band to grant access to your application. :param duration: Either ``"permanent"`` or ``"temporary"``. ``"temporary"`` authorizations generate access tokens that last only 1 hour. ``"permanent"`` authorizations additionally generate a refresh token that can be indefinitely used to generate new hour-long access tokens. Only ``"temporary"`` can be specified if ``implicit`` is set to ``True``. :param implicit: Use the implicit grant flow (default: ``False``). This flow is only available for :class:`.UntrustedAuthenticator` instances. :param scopes: A list of OAuth scopes to request authorization for. :param state: A string that will be reflected in the callback to ``redirect_uri``. Elements must be printable ASCII characters in the range ``0x20`` through ``0x7E`` inclusive. This value should be temporarily unique to the client for whom the URL was generated. :returns: URL to be used out-of-band for granting access to your application. :raises: :class:`.InvalidInvocation` if ``redirect_uri`` is not provided, if ``implicit`` is ``True`` and an authenticator other than :class:`.UntrustedAuthenticator` is used, or ``implicit`` is ``True`` and ``duration`` is ``"permanent"``. """ if self.redirect_uri is None: msg = "redirect URI not provided" raise InvalidInvocation(msg) if implicit and not isinstance(self, UntrustedAuthenticator): msg = "Only UntrustedAuthenticator instances can use the implicit grant flow." raise InvalidInvocation(msg) if implicit and duration != "temporary": msg = "The implicit grant flow only supports temporary access tokens." raise InvalidInvocation(msg) params = { "client_id": self.client_id, "duration": duration, "redirect_uri": self.redirect_uri, "response_type": "token" if implicit else "code", "scope": " ".join(scopes), "state": state, } url = self._requestor.reddit_url + const.AUTHORIZATION_PATH request = Request("GET", url, params=params) return cast("str", request.prepare().url) def revoke_token(self, token: str, /, *, token_type: str | None = None) -> None: """Ask Reddit to revoke the provided token. :param token: The access or refresh token to revoke. :param token_type: When provided, hint to Reddit what the token type is for a possible efficiency gain. The value can be either ``"access_token"`` or ``"refresh_token"``. """ data = {"token": token} if token_type is not None: data["token_type_hint"] = token_type url = self._requestor.reddit_url + const.REVOKE_TOKEN_PATH self._post(url=url, **data) class BaseAuthorizer: """Superclass for OAuth2 authorization tokens and scopes.""" AUTHENTICATOR_CLASS: type[BaseAuthenticator] | tuple[type[BaseAuthenticator], ...] = BaseAuthenticator @property def authenticator(self) -> BaseAuthenticator: """Return the :class:`.BaseAuthenticator` used to authenticate requests.""" return self._authenticator def __init__(self, *, authenticator: BaseAuthenticator) -> None: """Represent a single authorization to Reddit's API. :param authenticator: An instance of :class:`.BaseAuthenticator`. """ self._authenticator = authenticator self._clear_access_token() self._validate_authenticator() def _clear_access_token(self): self._expiration_timestamp_ns: int self.access_token: str | None = None self.scopes: set[str] | None = None def _request_token(self, **data: Any): url = self._authenticator.requestor.reddit_url + const.ACCESS_TOKEN_PATH pre_request_timestamp_ns = time.monotonic_ns() # _post is an internal helper shared between the authenticator and authorizer. response = self._authenticator._post(url=url, **data) # pyright: ignore[reportPrivateUsage] payload = response.json() if "error" in payload: # Why are these OKAY responses? raise OAuthException(response, payload["error"], payload.get("error_description")) self._expiration_timestamp_ns = pre_request_timestamp_ns + (payload["expires_in"] + 10) * const.NANOSECONDS self.access_token = payload["access_token"] if "refresh_token" in payload: self.refresh_token = payload["refresh_token"] self.scopes = set(payload["scope"].split(" ")) def _validate_authenticator(self): if not isinstance(self._authenticator, self.AUTHENTICATOR_CLASS): msg = "Must use an authenticator of type" if isinstance(self.AUTHENTICATOR_CLASS, type): msg += f" {self.AUTHENTICATOR_CLASS.__name__}." else: msg += f" {' or '.join([i.__name__ for i in self.AUTHENTICATOR_CLASS])}." raise InvalidInvocation(msg) def is_valid(self) -> bool: """Return whether the :class:`.Authorizer` is ready to authorize requests. A ``True`` return value does not guarantee that the ``access_token`` is actually valid on the server side. """ return self.access_token is not None and time.monotonic_ns() < self._expiration_timestamp_ns def revoke(self) -> None: """Revoke the current Authorization.""" if self.access_token is None: msg = "no token available to revoke" raise InvalidInvocation(msg) self._authenticator.revoke_token(self.access_token, token_type="access_token") # noqa: S106 self._clear_access_token() class TrustedAuthenticator(BaseAuthenticator): """Store OAuth2 authentication credentials for web, or script type apps.""" RESPONSE_TYPE: str = "code" def __init__( self, *, client_id: str, client_secret: str, redirect_uri: str | None = None, requestor: Requestor, ) -> None: """Represent a single authentication to Reddit's API. :param client_id: The OAuth2 client ID to use with the session. :param client_secret: The OAuth2 client secret to use with the session. :param redirect_uri: The redirect URI exactly as specified in your OAuth application settings on Reddit. This parameter is required if you want to use the :meth:`~.Authorizer.authorize_url` method, or the :meth:`~.Authorizer.authorize` method of the :class:`.Authorizer` class (default: ``None``). :param requestor: An instance of :class:`.Requestor`. """ super().__init__(client_id=client_id, redirect_uri=redirect_uri, requestor=requestor) self.client_secret = client_secret def _auth(self) -> tuple[str, str]: return self.client_id, self.client_secret class UntrustedAuthenticator(BaseAuthenticator): """Store OAuth2 authentication credentials for installed applications.""" def _auth(self) -> tuple[str, str]: return self.client_id, "" class Authorizer(BaseAuthorizer): """Manages OAuth2 authorization tokens and scopes.""" def __init__( self, *, authenticator: BaseAuthenticator, post_refresh_callback: Callable[[Authorizer], None] | None = None, pre_refresh_callback: Callable[[Authorizer], None] | None = None, refresh_token: str | None = None, ) -> None: """Represent a single authorization to Reddit's API. :param authenticator: An instance of a subclass of :class:`.BaseAuthenticator`. :param post_refresh_callback: When a single-argument function is passed, the function will be called prior to refreshing the access and refresh tokens. The argument to the callback is the :class:`.Authorizer` instance. This callback can be used to inspect and modify the attributes of the :class:`.Authorizer`. :param pre_refresh_callback: When a single-argument function is passed, the function will be called after refreshing the access and refresh tokens. The argument to the callback is the :class:`.Authorizer` instance. This callback can be used to inspect and modify the attributes of the :class:`.Authorizer`. :param refresh_token: Enables the ability to refresh the authorization. """ super().__init__(authenticator=authenticator) self._post_refresh_callback = post_refresh_callback self._pre_refresh_callback = pre_refresh_callback self.refresh_token = refresh_token def authorize(self, code: str, /) -> None: """Obtain and set authorization tokens based on ``code``. :param code: The code obtained by an out-of-band authorization request to Reddit. """ if self._authenticator.redirect_uri is None: msg = "redirect URI not provided" raise InvalidInvocation(msg) self._request_token( code=code, grant_type="authorization_code", redirect_uri=self._authenticator.redirect_uri, ) def refresh(self) -> None: """Obtain a new access token from the ``refresh_token``.""" if self._pre_refresh_callback: self._pre_refresh_callback(self) if self.refresh_token is None: msg = "refresh token not provided" raise InvalidInvocation(msg) self._request_token(grant_type="refresh_token", refresh_token=self.refresh_token) if self._post_refresh_callback: self._post_refresh_callback(self) def revoke(self, *, only_access: bool = False) -> None: """Revoke the current Authorization. :param only_access: When explicitly set to ``True``, do not evict the refresh token if one is set. Revoking a refresh token will in-turn revoke all access tokens associated with that authorization. """ if only_access or self.refresh_token is None: super().revoke() else: self._authenticator.revoke_token(self.refresh_token, token_type="refresh_token") # noqa: S106 self._clear_access_token() self.refresh_token = None class ImplicitAuthorizer(BaseAuthorizer): """Manages implicit installed-app type authorizations.""" AUTHENTICATOR_CLASS = UntrustedAuthenticator def __init__( self, *, access_token: str, authenticator: UntrustedAuthenticator, expires_in: int, scope: str, ) -> None: """Represent a single implicit authorization to Reddit's API. :param access_token: The ``access_token`` obtained from Reddit via callback to the authenticator's ``redirect_uri``. :param authenticator: An instance of :class:`.UntrustedAuthenticator`. :param expires_in: The number of seconds the ``access_token`` is valid for. The origin of this value was returned from Reddit via callback to the authenticator's redirect uri. Note, you may need to subtract an offset before passing in this number to account for a delay between when Reddit prepared the response, and when you make this function call. :param scope: A space-delimited string of Reddit OAuth2 scope names as returned from Reddit in the callback to the authenticator's redirect uri. """ super().__init__(authenticator=authenticator) self._expiration_timestamp_ns = time.monotonic_ns() + expires_in * const.NANOSECONDS self.access_token = access_token self.scopes = set(scope.split(" ")) class ReadOnlyAuthorizer(Authorizer): """Manages authorizations that are not associated with a Reddit account. While the ``"*"`` scope will be available, some endpoints simply will not work due to the lack of an associated Reddit account. """ AUTHENTICATOR_CLASS = TrustedAuthenticator def __init__( self, *, authenticator: BaseAuthenticator, scopes: list[str] | None = None, ) -> None: """Represent a ReadOnly authorization to Reddit's API. :param scopes: A list of OAuth scopes to request authorization for (default: ``None``). The scope ``"*"`` is requested when the default argument is used. """ super().__init__(authenticator=authenticator) self._scopes = scopes def refresh(self) -> None: """Obtain a new ReadOnly access token.""" additional_kwargs = {} if self._scopes: additional_kwargs["scope"] = " ".join(self._scopes) self._request_token(grant_type="client_credentials", **additional_kwargs) class ScriptAuthorizer(Authorizer): """Manages personal-use script type authorizations. Only users who are listed as developers for the application will be granted access tokens. """ AUTHENTICATOR_CLASS = TrustedAuthenticator def __init__( self, *, authenticator: BaseAuthenticator, password: str | None, scopes: list[str] | None = None, two_factor_callback: Callable[[], str] | None = None, username: str | None, ) -> None: """Represent a single personal-use authorization to Reddit's API. :param authenticator: An instance of :class:`.TrustedAuthenticator`. :param password: The password associated with ``username``. :param scopes: A list of OAuth scopes to request authorization for (default: ``None``). The scope ``"*"`` is requested when the default argument is used. :param two_factor_callback: A function that returns OTPs (One-Time Passcodes), also known as 2FA auth codes. If this function is provided, prawcore will call it when authenticating. :param username: The Reddit username of one of the application's developers. """ super().__init__(authenticator=authenticator) self._password = password self._scopes = scopes self._two_factor_callback = two_factor_callback self._username = username def refresh(self) -> None: """Obtain a new personal-use script type access token.""" additional_kwargs = {} if self._scopes: additional_kwargs["scope"] = " ".join(self._scopes) two_factor_code = self._two_factor_callback and self._two_factor_callback() if two_factor_code: additional_kwargs["otp"] = two_factor_code self._request_token( grant_type="password", username=self._username, password=self._password, **additional_kwargs, ) class DeviceIDAuthorizer(BaseAuthorizer): """Manages app-only OAuth2 for 'installed' applications. While the ``"*"`` scope will be available, some endpoints simply will not work due to the lack of an associated Reddit account. """ AUTHENTICATOR_CLASS = (TrustedAuthenticator, UntrustedAuthenticator) def __init__( self, *, authenticator: BaseAuthenticator, device_id: str | None = None, scopes: list[str] | None = None, ) -> None: """Represent an app-only OAuth2 authorization for 'installed' apps. :param authenticator: An instance of :class:`.UntrustedAuthenticator` or :class:`.TrustedAuthenticator`. :param device_id: A unique ID (20-30 character ASCII string) (default: ``None``). ``device_id`` is set to ``"DO_NOT_TRACK_THIS_DEVICE"`` when the default argument is used. For more information about this parameter, see: https://github.com/reddit/reddit/wiki/OAuth2#application-only-oauth :param scopes: A list of OAuth scopes to request authorization for (default: ``None``). The scope ``"*"`` is requested when the default argument is used. """ if device_id is None: device_id = "DO_NOT_TRACK_THIS_DEVICE" super().__init__(authenticator=authenticator) self._device_id = device_id self._scopes = scopes def refresh(self) -> None: """Obtain a new access token.""" additional_kwargs = {} if self._scopes: additional_kwargs["scope"] = " ".join(self._scopes) grant_type = "https://oauth.reddit.com/grants/installed_client" self._request_token( grant_type=grant_type, device_id=self._device_id, **additional_kwargs, )