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.

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

Storing user information as part of the job when security plugin is installed #113

Merged
merged 4 commits into from
Aug 9, 2021

Conversation

thalurur
Copy link
Contributor

@thalurur thalurur commented Aug 5, 2021

Issue #, if available:
#75

Description of changes:
Storing user object as part of the job when information is available and setting the user roles in threadcontext while running the ISM policy actions to ensure the user who created managed indices have the necessary permissions before running the action

CheckList:
[ ] Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@codecov-commenter
Copy link

codecov-commenter commented Aug 5, 2021

Codecov Report

Merging #113 (8687c0f) into main (1860f38) will decrease coverage by 0.00%.
The diff coverage is 75.79%.

Impacted file tree graph

@@             Coverage Diff              @@
##               main     #113      +/-   ##
============================================
- Coverage     78.24%   78.23%   -0.01%     
- Complexity     1894     1908      +14     
============================================
  Files           255      256       +1     
  Lines         10461    10508      +47     
  Branches       1546     1563      +17     
============================================
+ Hits           8185     8221      +36     
+ Misses         1420     1414       -6     
- Partials        856      873      +17     
Impacted Files Coverage Δ
...agement/indexstatemanagement/ISMTemplateService.kt 79.54% <ø> (+4.54%) ⬆️
...ent/transport/action/explain/ExplainAllResponse.kt 96.00% <0.00%> (ø)
...g/opensearch/indexmanagement/util/SecurityUtils.kt 44.44% <44.44%> (ø)
...agement/indexstatemanagement/model/ChangePolicy.kt 80.39% <57.14%> (-10.09%) ⬇️
...dexmanagement/indexstatemanagement/model/Policy.kt 82.88% <58.33%> (-3.26%) ⬇️
...ment/indexstatemanagement/util/RestHandlerUtils.kt 93.75% <66.66%> (-6.25%) ⬇️
...nt/indexstatemanagement/ManagedIndexCoordinator.kt 73.43% <73.21%> (-0.85%) ⬇️
...t/indexstatemanagement/model/ManagedIndexConfig.kt 79.80% <80.00%> (-1.20%) ⬇️
...exmanagement/opensearchapi/OpenSearchExtensions.kt 82.53% <83.33%> (+0.18%) ⬆️
...pensearch/indexmanagement/IndexManagementPlugin.kt 92.30% <100.00%> (+0.03%) ⬆️
... and 16 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1860f38...8687c0f. Read the comment docs.

@@ -283,7 +291,7 @@ object ManagedIndexRunner :
}

val state = policy.getStateToExecute(managedIndexMetaData)
val action: Action? = state?.getActionToExecute(clusterService, scriptService, client, settings, managedIndexMetaData)
val action: Action? = state?.getActionToExecute(clusterService, scriptService, client, settings, managedIndexMetaData.copy(user = managedIndexConfig.user))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this for?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So the User information is available inside the Step for Rollup ISM Action the User object needs to be populated from the managed Index

Copy link
Contributor

@dbbaughe dbbaughe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I saw we have user saved on policies, managed index configs, and managed index metadata?
Why do we need the user on all three versus just on the policy?

* Helper method to build the user object either from the threadContext or from the requested user.
*/
fun buildUser(threadContext: ThreadContext, requestedUser: User? = null): User? {
if (threadContext.getTransient<Boolean>(INTERNAL_REQUEST) != null && threadContext.getTransient<Boolean>(INTERNAL_REQUEST)) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think these getTransients can throw exceptions, should we wrap these in a try catch or does the caller do it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let me check, I haven't seen any errors with getTransient, Alerting and other plugins are using the getTransient as part of every transport action with out any wrapper.

@thalurur
Copy link
Contributor Author

thalurur commented Aug 6, 2021

I saw we have user saved on policies, managed index configs, and managed index metadata?
Why do we need the user on all three versus just on the policy?

We are not persisting user information in managed index metadata, its just part of the instance object that is passed to Step. However, we are persisting it in Policy and ManagedIndex as top level field. When policy is copied over to ManagedIndex we are not storing the User object inside the ManagedIndex.Policy path.
The user field in ManagedIndex and Policy will be used to filter the data when fetching these for read APIs

Signed-off-by: Ravi Thaluru <ravi1092@gmail.com>
@thalurur thalurur merged commit 11da83f into opensearch-project:main Aug 9, 2021
downsrob added a commit that referenced this pull request Nov 5, 2021
* Add integTest script to the repo (#94)

Signed-off-by: Peter Zhu <zhujiaxi@amazon.com>

* Removing Usages of Action Get Call and using listeners (#100)

Signed-off-by: Aditya Jindal <aditjind@amazon.com>

* Enhance ISM template (#105)

Signed-off-by: bowenlan-amzn <bowenlan23@gmail.com>

* Explain response still use old opendistro policy id (#109)

* Explain response still use old opendistro policy id
* Use hardcoded policyid setting in tests for explain response
* Trying to fix flaky tests

* Storing user information as part of the job when security plugin is installed (#113)

Signed-off-by: Ravi Thaluru <ravi1092@gmail.com>

* ISM/Notification channel support (#117)

* Updates NAME of transport actions

* Upgrades Kotlin version, updates dependencies on other OS plugins, adds notification plugin as a test resource and includes it in test clusters

* Adds support for Channels in error notifications and notification actions

* Adds support for sending notifications to channels

* Adds support for publishing notifications to the legacy destinations through the Notification plugin and some cleanup

* Removes notification alerting jar dependency

* Adds compile only dep on commons codec for digest utils sha1 method in ism rollup

* Updates Error Notification to make channel/destination nullable, and adds helper methods for publish calls

* Constructs URL for legacy custom webhook

Signed-off-by: Drew Baugher <46505179+dbbaughe@users.noreply.github.com>

* Fixes Feature enum and dep

Signed-off-by: Drew Baugher <46505179+dbbaughe@users.noreply.github.com>

* Trying something else

Signed-off-by: Drew Baugher <46505179+dbbaughe@users.noreply.github.com>

* Addresses comments

Signed-off-by: Drew Baugher <46505179+dbbaughe@users.noreply.github.com>

* Storing user object in all APIs and enabling filter of response based on user (#115)

Signed-off-by: Ravi Thaluru <ravi1092@gmail.com>

* Upgrade dependencies to 1.1 and build snapshot by default. (#121)

Signed-off-by: dblock <dblock@amazon.com>

* Security improvements  (#126)

Signed-off-by: Ravi Thaluru <ravi1092@gmail.com>

* Removes support for notification plugin (#136)

Signed-off-by: Drew Baugher <46505179+dbbaughe@users.noreply.github.com>

* Updating security filtering logic (#137)

Signed-off-by: Ravi Thaluru <ravi1092@gmail.com>

* Release note for 1.1.0.0 release. (#139)

* Release note for 1.1.0.0 release.

Signed-off-by: bowenlan-amzn <bowenlan23@gmail.com>

* Correct copyright notices

* Uses published daily snapshot dependencies (#141)

Signed-off-by: Drew Baugher <46505179+dbbaughe@users.noreply.github.com>

* License header check (#142)

* Provide default copyright header using IDE feature

Signed-off-by: bowenlan-amzn <bowenlan23@gmail.com>

* Address #103

history write index is rolled over even if the history indices are
disabled

* Removed integtest.sh. (#148)

Signed-off-by: dblock <dblock@dblock.org>

* Adds mavenLocal back to repositories (#158)

Signed-off-by: Drew Baugher <46505179+dbbaughe@users.noreply.github.com>

* Making snapshot name to scripted input in template  (#77)

Signed-off-by: Ravi Thaluru <ravi1092@gmail.com>

* Fix issues with security changes in rollup runnner (#161)

* Updates index management version to 1.2 (#157)

* Updates index management version to 1.2

* Updates job scheduler snapshot to 1.2 in test resources

Signed-off-by: Robert Downs <downsrob@amazon.com>

* Adds setting to search all rollup jobs on a target index (#165)

* Adds cluster setting to search all rollup jobs

Signed-off-by: Clay Downs <downsrob@amazon.com>

* Adds implementation for the delay feature in rollup jobs (#147)

* Adds delay implementation for rollup jobs

* Removes non-continuous delay implementation

* Adds additional rollup delay tests

Signed-off-by: Clay Downs <downsrob@amazon.com>

* Updates testCompile mockito version, adds AwaitsFix annotation to MetadataRegressionIT tests (#168)

* Updates testCompile mockito version to match OpenSearch changes

* AwaitsFix on the failing MetadataRegressionIT tests

Signed-off-by: Robert Downs <downsrob@amazon.com>

* Adds cluster setting to configure index state management jitter (#153)

* Adds jitter cluster setting, sets jitter to 0 for ISM tests

Signed-off-by: Clay Downs <downsrob@amazon.com>

* Allows out of band rollovers on an index without causing ISM to fail (#180)

* Allows out of band rollovers on an index without causing ISM to fail

Signed-off-by: Drew Baugher <46505179+dbbaughe@users.noreply.github.com>

* Fixes detekt issue

Signed-off-by: Drew Baugher <46505179+dbbaughe@users.noreply.github.com>

* Remove policy API on read only indices (#182)

* In explain API not showing the total count to all users (#185)

Co-authored-by: Peter Zhu <zhujiaxi@amazon.com>
Co-authored-by: Aditya Jindal <13850971+aditjind@users.noreply.github.com>
Co-authored-by: Bowen Lan <62091230+bowenlan-amzn@users.noreply.github.com>
Co-authored-by: Ravi <6005951+thalurur@users.noreply.github.com>
Co-authored-by: Drew Baugher <46505179+dbbaughe@users.noreply.github.com>
Co-authored-by: Daniel Doubrovkine (dB.) <dblock@dblock.org>
wuychn pushed a commit to ochprince/index-management that referenced this pull request Mar 16, 2023
…nstalled (opensearch-project#113)

Signed-off-by: Ravi Thaluru <ravi1092@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants