-
Notifications
You must be signed in to change notification settings - Fork 204
Fix bug in support for jwt.url_param customization #1025
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"). | ||
| * You may not use this file except in compliance with the License. | ||
| * A copy of the License is located at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * or in the "license" file accompanying this file. This file is distributed | ||
| * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
| * express or implied. See the License for the specific language governing | ||
| * permissions and limitations under the License. | ||
| */ | ||
|
|
||
| import { getAuthenticationHandler } from '../../auth_handler_factory'; | ||
|
|
||
| describe('test jwt auth library', () => { | ||
| const router: IRouter = { post: (body) => {} }; | ||
| let core: CoreSetup; | ||
| let esClient: ILegacyClusterClient; | ||
| let sessionStorageFactory: SessionStorageFactory<SecuritySessionCookie>; | ||
| let logger: Logger; | ||
|
|
||
| function getTestJWTAuthenticationHandlerWithConfig(config: SecurityPluginConfigType) { | ||
| return getAuthenticationHandler( | ||
| 'jwt', | ||
| router, | ||
| config, | ||
| core, | ||
| esClient, | ||
| sessionStorageFactory, | ||
| logger | ||
| ); | ||
| } | ||
|
|
||
| test('test getTokenFromUrlParam', () => { | ||
| const config = { | ||
| jwt: { | ||
| header: 'Authorization', | ||
| url_param: 'authorization', | ||
| }, | ||
| }; | ||
| const auth = getTestJWTAuthenticationHandlerWithConfig(config); | ||
|
|
||
| const url = new URL('http://localhost:5601/app/api/v1/auth/authinfo?authorization=testtoken'); | ||
| const request = { | ||
| url, | ||
| }; | ||
|
|
||
| const expectedToken = 'testtoken'; | ||
| const token = auth.getTokenFromUrlParam(request); | ||
| expect(token).toEqual(expectedToken); | ||
| }); | ||
|
|
||
| test('test getTokenFromUrlParam incorrect url_param', () => { | ||
| const config = { | ||
| jwt: { | ||
| header: 'Authorization', | ||
| url_param: 'urlParamName', | ||
| }, | ||
| }; | ||
| const auth = getTestJWTAuthenticationHandlerWithConfig(config); | ||
|
|
||
| const url = new URL('http://localhost:5601/app/api/v1/auth/authinfo?authorization=testtoken'); | ||
| const request = { | ||
| url, | ||
| }; | ||
|
|
||
| const expectedToken = undefined; | ||
| const token = auth.getTokenFromUrlParam(request); | ||
| expect(token).toEqual(expectedToken); | ||
| }); | ||
| }); | ||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: I like smaller test functions that make it clearer what is being tested, could you refactor the call for
getAuthenticationHandlerto be a private function to make the test case read more likeSetup / Action / VerificationThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I created a helper function in this fixture called
getTestJWTAuthenticationHandlerWithConfigto reduce some duplication and make the tests tighter.