Feat/flight sql bearer auth example #22
Merged
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
This commit introduces a new example, `bearer_auth_flight_sql.rs`, demonstrating how to implement Bearer Token authentication in a DataFusion Flight SQL server.
The example includes:
- A tonic interceptor (`bearer_auth_interceptor`) for validating Bearer tokens from the "authorization" header.
- A `UserData` struct to store information extracted from valid tokens, which is then added to request extensions.
- A custom `SessionStateProvider` (`MySessionStateProvider`) that retrieves `UserData` from request extensions to create or customize the `SessionState`. This provider also registers a sample CSV table ("test") for querying.
- Server-side setup to integrate the interceptor and custom session provider.
- Client-side test cases in the `main` function that attempt `GetTables` Flight SQL calls with:
- A valid token (expected to succeed).
- An invalid token (expected to fail).
- No token (expected to fail).
- Module-level documentation explaining the example's functionality and components.
This example serves as a guide for you if you are looking to implement request-level authentication and session customization in your Flight SQL services.
hozan23
approved these changes
May 21, 2025
This was referenced May 21, 2025
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.
To test Jules, I asked it to add a bearer auth example. With a bit of cleanup it works now.
It could probably be made more concise but it does serve as a decent illustration. Remaining list issue seems unrelated.