Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[vdk-plugins] vdk-control-api-auth: Add authorization code flow #834

Merged
merged 1 commit into from
May 16, 2022
Merged

[vdk-plugins] vdk-control-api-auth: Add authorization code flow #834

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion projects/vdk-plugins/vdk-control-api-auth/src/vdk/plugin/control_api_auth/authentication.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
# SPDX-License-Identifier: Apache-2.0
from vdk.plugin.control_api_auth.auth_config import InMemAuthConfiguration
from vdk.plugin.control_api_auth.auth_exception import VDKAuthException
from vdk.plugin.control_api_auth.autorization_code_auth import RedirectAuthentication
from vdk.plugin.control_api_auth.base_auth import BaseAuth
from vdk.plugin.control_api_auth.login_types import LoginTypes

Expand All @@ -17,6 +18,7 @@ def __init__(
client_secret: str = None,
token: str = None,
authorization_url: str = None,
auth_discovery_url: str = None,
auth_type: str = None,
cache_locally: bool = False,
):
Expand All @@ -35,6 +37,8 @@ def __init__(
to obtain access token from the authorization server.
:param authorization_url:
The URL which exchanges token for access token.
:param auth_discovery_url:
Token or Authorization URI used to exchange grant for access token.
:param auth_type:
What type of authentication should be used (e.g., refresh_token,
basic_auth, etc.).
Expand All @@ -48,6 +52,7 @@ def __init__(
self._client_secret = client_secret
self._token = token
self._auth_url = authorization_url
self._auth_discovery_url = auth_discovery_url
self._auth_type = auth_type
# Check if credentials should be cached on the local filesystem
if cache_locally:
Expand Down Expand Up @@ -75,6 +80,8 @@ def authenticate(self) -> None:

if self._auth_type == LoginTypes.API_TOKEN.value:
self.__authenticate_with_api_token()
elif self._auth_type == LoginTypes.CREDENTIALS.value:
self.__authenticate_with_authorization_code()
else:
raise VDKAuthException(
what="Unexpected authentication type.",
Expand All @@ -101,6 +108,25 @@ def __authenticate_with_authorization_code(self):
"""
Authenticate with authorization code as described in
https://datatracker.ietf.org/doc/html/rfc6749#section-1.3.1
This type of authentication relies on pkce
https://datatracker.ietf.org/doc/html/rfc7636
:return:
"""
raise NotImplementedError("This method is yet to be implemented.")
if not self._client_id or not self._auth_discovery_url:
raise VDKAuthException(
what="Unable to log in.",
why=f"Login type {self._auth_type} requires client_id and "
"auth_discovery_url to be specified.",
consequence="The authentication operation cannot be complete.",
countermeasure="Specify client_id and auth_discovery_url and "
"repeat the login operation.",
)
else:
auth_code_flow = RedirectAuthentication(
client_id=self._client_id,
client_secret=self._client_secret,
oauth2_discovery_url=self._auth_discovery_url,
oauth2_exchange_url=self._auth_url,
auth=self._auth,
)
auth_code_flow.authentication_process()
Loading