feat(framework) Add Keycloak user auth CLI integration #4602
Conversation
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
…lugin' into add-keycloak-auth-plugin
danielnugraha
requested review from
tanertopal and
danieljanes
as code owners
danielnugraha
changed the title
panh99
reviewed
Dec 2, 2024
panh99
reviewed
Dec 2, 2024
panh99
reviewed
Dec 2, 2024
Co-authored-by: Heng Pan <[email protected]>
Co-authored-by: Heng Pan <[email protected]>
Co-authored-by: Heng Pan <[email protected]>
Co-authored-by: Heng Pan <[email protected]>
panh99
reviewed
Dec 3, 2024
| ) | ||
|
|
||
| base_path = get_flwr_dir() | ||
| credentials_dir = base_path / ".credentials" |
There was a problem hiding this comment.
Could you make this .credentials as a constant? Like the APP_DIR in flwr.common.constant.
Comment on lines
+37
to
+42
| try: | ||
| from flwr.ee.auth_plugin import get_cli_auth_plugins | ||
|
|
||
| auth_plugins = get_cli_auth_plugins() | ||
| except ImportError: | ||
| auth_plugins = [] |
There was a problem hiding this comment.
I think we may use the trick as in simulation sub-package.
Suggested change
| try: | |
| from flwr.ee.auth_plugin import get_cli_auth_plugins | |
| auth_plugins = get_cli_auth_plugins() | |
| except ImportError: | |
| auth_plugins = [] | |
| try: | |
| from flwr.ee.auth_plugin import get_cli_auth_plugins | |
| except ImportError: | |
| AUTH_PLUGIN_IMPORT_ERROR: str = """Unable to import module `flwr.ee.auth_plugin`. | |
| This is a feature available only in the enterprise extension. | |
| """ | |
| def get_cli_auth_plugins() -> dict[str, type[CliAuthPlugin]]: | |
| raise ImportError(AUTH_PLUGIN_IMPORT_ERROR) | |
There was a problem hiding this comment.
May I suggest:
- This is a feature available only in the enterprise extension.
+ This feature is only available in the Flower Enterprise extension. Please visit https://flower.ai to learn more.| stub = _create_exec_stub(app, federation_config) | ||
| login_request = LoginRequest() | ||
| login_response: LoginResponse = stub.Login(login_request) | ||
| auth_plugin = auth_plugins[login_response.login_details.get("auth_type", "")] |
There was a problem hiding this comment.
Suggested change
| auth_plugin = auth_plugins[login_response.login_details.get("auth_type", "")] | |
| auth_plugin = get_cli_auth_plugins()[login_response.login_details["auth_type"]] |
chongshenng
reviewed
Dec 3, 2024
| typer.Argument(help="Name of the federation to login into."), | ||
| ] = None, | ||
| ) -> None: | ||
| """Login to Flower SuperExec.""" |
There was a problem hiding this comment.
Suggested change
| """Login to Flower SuperExec.""" | |
| """Login to Flower SuperLink.""" |
chongshenng
reviewed
Dec 3, 2024
Comment on lines
+73
to
+75
| f"❌ The federation `{federation}` does not have `SuperExec` " | ||
| "address in its config.\n Please specify the address in " | ||
| "`pyproject.toml` and try again.", |
There was a problem hiding this comment.
Suggested change
| f"❌ The federation `{federation}` does not have `SuperExec` " | |
| "address in its config.\n Please specify the address in " | |
| "`pyproject.toml` and try again.", | |
| "❌ `flwr login` currently works with Exec API. Ensure that the correct" | |
| "Exec API address is provided in the `pyproject.toml`.", |
This is to make it consistent with flwr ls and flwr log.
chongshenng
reviewed
Dec 3, 2024
Comment on lines
+92
to
+97
| server_address = federation_config["address"] | ||
| parsed_address = parse_address(server_address) | ||
| if not parsed_address: | ||
| sys.exit(f"Server IP address ({server_address}) cannot be parsed.") | ||
| host, port, is_v6 = parsed_address | ||
| address = f"[{host}]/{port}" if is_v6 else f"{host}/{port}" |
There was a problem hiding this comment.
Can you reuse the functionality here?
chongshenng
reviewed
Dec 3, 2024
There was a problem hiding this comment.
I've reviewed only login.py so far. @danielnugraha, should I continue to review the remaining parts?
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.
Issue
Description
We need user authentication logic when user wants to run via
flwr run.Related issues/PRs
Proposal
Explanation
Add
flwr logincommand logic and user authentication logic inflwr run.Checklist
#contributions)Any other comments?