Implement OAuth2 Client Credentials for Okta #6963
Draft
Conversation
This file contains hidden or 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
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
Contributor
Greptile OverviewGreptile SummaryThis PR introduces a new Critical Issue:
Minor Issues:
Confidence Score: 1/5
Important Files ChangedFile Analysis
|
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Comment on lines
1
to
150
| from __future__ import annotations | ||
|
|
||
| from datetime import datetime, timedelta | ||
| from typing import Callable, Dict, Optional | ||
|
|
||
| import requests | ||
| from loguru import logger | ||
| from requests.auth import HTTPBasicAuth | ||
| from sqlalchemy.orm import Session | ||
|
|
||
| from fides.api.common_exceptions import ConnectionException, OAuth2TokenException | ||
| from fides.api.models.connectionconfig import ConnectionConfig | ||
|
|
||
|
|
||
| class OktaOAuth2Client: | ||
| """ | ||
| Lightweight OAuth2 Client Credentials helper for Okta. | ||
|
|
||
| This class encapsulates token acquisition, caching, and persistence in the | ||
| `ConnectionConfig` secrets for the Okta connector/worker use case. | ||
| """ | ||
|
|
||
| TOKEN_PATH = "/oauth2/v1/token" | ||
| DEFAULT_SCOPE = "okta.apps.read" | ||
| DEFAULT_EXPIRATION_SECONDS = 3600 | ||
| EXPIRATION_BUFFER_SECONDS = 300 | ||
|
|
||
| def __init__( | ||
| self, | ||
| connection_config: ConnectionConfig, | ||
| *, | ||
| scope: Optional[str] = None, | ||
| clock: Callable[[], datetime] = datetime.utcnow, | ||
| ) -> None: | ||
| self.connection_config = connection_config | ||
| self.scope = scope or self.DEFAULT_SCOPE | ||
| self.clock = clock | ||
|
|
||
| def get_access_token(self, db: Optional[Session] = None) -> str: | ||
| """ | ||
| Retrieve a valid OAuth2 access token for Okta. | ||
| Returns a cached token when still valid or requests a new one as needed. | ||
| """ | ||
| self._validate_required_secrets() | ||
|
|
||
| secrets = self.connection_config.secrets or {} | ||
| access_token: Optional[str] = secrets.get("access_token") | ||
| expires_at: Optional[int] = secrets.get("expires_at") | ||
|
|
||
| if access_token and self._token_is_valid(expires_at): | ||
| return access_token | ||
|
|
||
| token_response = self._request_new_token() | ||
| return self._persist_token(token_response, db) | ||
|
|
||
| def _validate_required_secrets(self) -> None: | ||
| secrets = self.connection_config.secrets or {} | ||
| missing = [ | ||
| secret_name | ||
| for secret_name in ("org_url", "client_id", "client_secret") | ||
| if not secrets.get(secret_name) | ||
| ] | ||
| if missing: | ||
| raise ConnectionException( | ||
| "Okta connection configuration is missing required OAuth2 secrets: " | ||
| + ", ".join(missing) | ||
| ) | ||
|
|
||
| def _token_is_valid(self, expires_at: Optional[int]) -> bool: | ||
| if not expires_at: | ||
| return False | ||
|
|
||
| buffer_time = self.clock() + timedelta(seconds=self.EXPIRATION_BUFFER_SECONDS) | ||
| return expires_at > int(buffer_time.timestamp()) | ||
|
|
||
| def _token_endpoint(self) -> str: | ||
| org_url: str = self.connection_config.secrets.get("org_url") # type: ignore | ||
| # Ensure only a single slash between org_url and the token path | ||
| return org_url.rstrip("/") + self.TOKEN_PATH | ||
|
|
||
| def _request_new_token(self) -> Dict[str, str]: | ||
| secrets = self.connection_config.secrets or {} | ||
| client_id: str = secrets.get("client_id") # type: ignore | ||
| client_secret: str = secrets.get("client_secret") # type: ignore | ||
|
|
||
| data = { | ||
| "grant_type": "client_credentials", | ||
| "scope": self.scope, | ||
| } | ||
|
|
||
| try: | ||
| response = requests.post( | ||
| self._token_endpoint(), | ||
| data=data, | ||
| headers={"Content-Type": "application/x-www-form-urlencoded"}, | ||
| auth=HTTPBasicAuth(client_id, client_secret), | ||
| timeout=30, | ||
| ) | ||
| except requests.exceptions.RequestException as exc: # pragma: no cover | ||
| logger.error("Error requesting Okta OAuth2 access token: {}", exc) | ||
| raise OAuth2TokenException( | ||
| f"Error occurred during the access token request for {self.connection_config.key}: {exc}" | ||
| ) from exc | ||
|
|
||
| if response.status_code != 200: | ||
| logger.error( | ||
| "Okta OAuth2 token request failed with status {}: {}", | ||
| response.status_code, | ||
| response.text, | ||
| ) | ||
| raise OAuth2TokenException( | ||
| f"Unable to retrieve token for {self.connection_config.key}. " | ||
| f"Status code: {response.status_code}" | ||
| ) | ||
|
|
||
| try: | ||
| return response.json() | ||
| except ValueError as exc: | ||
| logger.error("Invalid JSON in Okta OAuth2 token response: {}", exc) | ||
| raise OAuth2TokenException( | ||
| f"Invalid JSON response retrieving token for {self.connection_config.key}: {exc}" | ||
| ) from exc | ||
|
|
||
| def _persist_token( | ||
| self, token_response: Dict[str, str], db: Optional[Session] | ||
| ) -> str: | ||
| access_token = token_response.get("access_token") | ||
| if not access_token: | ||
| logger.error("Okta OAuth2 token response missing access_token: {}", token_response) | ||
| raise OAuth2TokenException( | ||
| f"Unable to retrieve token for {self.connection_config.key} (missing access_token)." | ||
| ) | ||
|
|
||
| expires_in = token_response.get("expires_in") or self.DEFAULT_EXPIRATION_SECONDS | ||
| expires_at = int(self.clock().timestamp()) + int(expires_in) | ||
|
|
||
| updated_secrets = { | ||
| **(self.connection_config.secrets or {}), | ||
| "access_token": access_token, | ||
| "expires_at": expires_at, | ||
| } | ||
|
|
||
| db = db or Session.object_session(self.connection_config) | ||
| if db is None: | ||
| logger.warning( | ||
| "Okta OAuth2 token persistence without DB session for {}", self.connection_config.key | ||
| ) | ||
|
|
||
| self.connection_config.update(db, data={"secrets": updated_secrets}) | ||
| return access_token |
Contributor
There was a problem hiding this comment.
logic: OktaOAuth2Client is created but never used anywhere in the codebase. The OktaConnector._get_oauth_access_token() still expects a pre-existing access_token in secrets, but doesn't use this client to fetch or refresh tokens. This implementation won't actually enable OAuth2 client credentials flow unless integrated.
Contributor
Author
There was a problem hiding this comment.
This is a base structure that will be used later for the OAuth2 integration with Okta.
| connection_config: ConnectionConfig, | ||
| *, | ||
| scope: Optional[str] = None, | ||
| clock: Callable[[], datetime] = datetime.utcnow, |
Contributor
There was a problem hiding this comment.
style: datetime.utcnow() is deprecated in Python 3.12+. While the codebase uses it extensively, consider using datetime.now(timezone.utc) for new code to avoid future deprecation warnings.
Comment on lines
56
to
67
| def _validate_required_secrets(self) -> None: | ||
| secrets = self.connection_config.secrets or {} | ||
| missing = [ | ||
| secret_name | ||
| for secret_name in ("org_url", "client_id", "client_secret") | ||
| if not secrets.get(secret_name) | ||
| ] | ||
| if missing: | ||
| raise ConnectionException( | ||
| "Okta connection configuration is missing required OAuth2 secrets: " | ||
| + ", ".join(missing) | ||
| ) |
Contributor
There was a problem hiding this comment.
style: consider making this a static method since it doesn't use instance state beyond what's passed as parameters
Context Used: Rule from dashboard - Use static methods instead of instance methods when the method doesn't require instance state. (source)
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## ENG-1916 #6963 +/- ##
============================================
+ Coverage 82.07% 82.08% +0.01%
============================================
Files 525 526 +1
Lines 34446 34511 +65
Branches 3966 3970 +4
============================================
+ Hits 28270 28330 +60
- Misses 5355 5359 +4
- Partials 821 822 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ticket ENG-1952 (https://ethyca.atlassian.net/browse/ENG-1952)
Description Of Changes
Introduced a dedicated OktaOAuth2Client helper that encapsulates the OAuth2 Client Credentials flow for the Okta discovery worker. The helper validates required secrets, reuses cached tokens when still valid, refreshes tokens proactively, and persists refreshed values back into the ConnectionConfig. Added unit tests covering cached-token reuse, token refresh, error handling, and missing-secret scenarios.
Code Changes
created OktaOAuth2Client with token acquisition, caching, and persistence logic under src/fides/api/service/connectors/okta_oauth2_client.py
added pytest coverage for the helper in tests/ops/service/connectors/test_okta_oauth2_client.py using a minimal DummyConnectionConfig
Steps to Confirm
Pre-Merge Checklist
CHANGELOG.mdupdatedmaindowngrade()migration is correct and works