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

Integrates OpenSAML 4.3 with SAML authenticator #3651

Merged

Conversation

willyborankin
Copy link
Collaborator

@willyborankin willyborankin commented Nov 4, 2023

Description

In order to exclude permission org.opensearch.secure_sm.ThreadPermission "modifyArbitraryThread"; we must use the dedicated cleaners thread factory in OpenSearch. Since OpenSAML packages are sealed it it impossible to replace CleanerSupport class with our own solution. Instead we have to change configuration of how such objects should be parsed. There are only 2 classes in the library which use CleanerSupport:

  • X509CertificateImpl
  • X509CRLImpl

This fix uses the same solution as in OpenSAML and replaces CleanerSupport with our custom implementation CleanerFactory.

Issues Resolved

#2989

Check List

  • New functionality includes testing
  • New functionality has been documented
  • 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.

Copy link
Member

@DarshitChanpura DarshitChanpura left a comment

Choose a reason for hiding this comment

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

Thank you for opening this PR @willyborankin. A general request: could you please add description to all new classes to help understand the role of each class?

Also, would you mind adding some tests for this?

Signed-off-by: Andrey Pleskach <[email protected]>
@willyborankin
Copy link
Collaborator Author

@reta and @DarshitChanpura comments addressed

Signed-off-by: Andrey Pleskach <[email protected]>
Copy link
Contributor

@stephen-crawford stephen-crawford left a comment

Choose a reason for hiding this comment

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

Since this is a refactor of SAML, I think the existing tests should be sufficient. This looks good to me.

@DarshitChanpura
Copy link
Member

DarshitChanpura commented Nov 7, 2023

@reta I've resolved the conversations since you've given your approval.

Copy link
Member

@DarshitChanpura DarshitChanpura left a comment

Choose a reason for hiding this comment

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

Thank you @willyborankin !

@DarshitChanpura DarshitChanpura changed the title OpenSAML 4.3 integration Integrates OpenSAML 4.3 with SAML authenticator Nov 7, 2023
@DarshitChanpura DarshitChanpura merged commit 44a03c5 into opensearch-project:main Nov 7, 2023
75 checks passed
@DarshitChanpura
Copy link
Member

@willyborankin Is this ready to be backported to 2.x?

@willyborankin
Copy link
Collaborator Author

@willyborankin Is this ready to be backported to 2.x?

@DarshitChanpura lets see how it will behave with other tests. If it is ok lets add the label.

willyborankin pushed a commit that referenced this pull request Nov 7, 2023
### Description
We have added Spotless formatting rules already, this pull request adds
import ordering to Spotless formatting rules

### Issues Resolved
Follow up on #3651


### Testing
N/A

### Check List
- [ ] New functionality includes testing
- [ ] New functionality has been documented
- [X] 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](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).

Signed-off-by: Andriy Redko <[email protected]>
reta added a commit to reta/security that referenced this pull request Nov 7, 2023
…3666)

We have added Spotless formatting rules already, this pull request adds
import ordering to Spotless formatting rules

Follow up on opensearch-project#3651

N/A

- [ ] New functionality includes testing
- [ ] New functionality has been documented
- [X] 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](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).

Signed-off-by: Andriy Redko <[email protected]>
(cherry picked from commit 905c97d)
@willyborankin willyborankin added the backport 2.11 Backport to 2.11 branch label Nov 8, 2023
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.11 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/security/backport-2.11 2.11
# Navigate to the new working tree
pushd ../.worktrees/security/backport-2.11
# Create a new branch
git switch --create backport/backport-3651-to-2.11
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 44a03c5a5929357a2e936b45dd754085fd282f0f
# Push it to GitHub
git push --set-upstream origin backport/backport-3651-to-2.11
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/security/backport-2.11

Then, create a pull request where the base branch is 2.11 and the compare/head branch is backport/backport-3651-to-2.11.

@willyborankin willyborankin added backport 2.x backport to 2.x branch and removed backport 2.11 Backport to 2.11 branch backport-failed labels Nov 8, 2023
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/security/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/security/backport-2.x
# Create a new branch
git switch --create backport/backport-3651-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 44a03c5a5929357a2e936b45dd754085fd282f0f
# Push it to GitHub
git push --set-upstream origin backport/backport-3651-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/security/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-3651-to-2.x.

willyborankin added a commit to willyborankin/security that referenced this pull request Nov 8, 2023
)

In order to exclude `permission
org.opensearch.secure_sm.ThreadPermission "modifyArbitraryThread";` we
must use the dedicated `cleaners` thread factory in `OpenSearch`. Since
`OpenSAML` packages are sealed it it impossible to replace
`CleanerSupport` class with our own solution. Instead we have to change
configuration of how such objects should be parsed. There are only 2
classes in the library which use `CleanerSupport`:
 - `X509CertificateImpl`
 - `X509CRLImpl`

This fix uses the same solution as in `OpenSAML` and replaces
`CleanerSupport` with our custom implementation `CleanerFactory`.

Signed-off-by: Andrey Pleskach <[email protected]>
(cherry picked from commit 44a03c5)
Signed-off-by: Andrey Pleskach <[email protected]>
willyborankin added a commit to willyborankin/security that referenced this pull request Nov 13, 2023
)

In order to exclude `permission
org.opensearch.secure_sm.ThreadPermission "modifyArbitraryThread";` we
must use the dedicated `cleaners` thread factory in `OpenSearch`. Since
`OpenSAML` packages are sealed it it impossible to replace
`CleanerSupport` class with our own solution. Instead we have to change
configuration of how such objects should be parsed. There are only 2
classes in the library which use `CleanerSupport`:
 - `X509CertificateImpl`
 - `X509CRLImpl`

This fix uses the same solution as in `OpenSAML` and replaces
`CleanerSupport` with our custom implementation `CleanerFactory`.

Signed-off-by: Andrey Pleskach <[email protected]>
(cherry picked from commit 44a03c5)
Signed-off-by: Andrey Pleskach <[email protected]>
willyborankin added a commit to willyborankin/security that referenced this pull request Nov 20, 2023
)

In order to exclude `permission
org.opensearch.secure_sm.ThreadPermission "modifyArbitraryThread";` we
must use the dedicated `cleaners` thread factory in `OpenSearch`. Since
`OpenSAML` packages are sealed it it impossible to replace
`CleanerSupport` class with our own solution. Instead we have to change
configuration of how such objects should be parsed. There are only 2
classes in the library which use `CleanerSupport`:
 - `X509CertificateImpl`
 - `X509CRLImpl`

This fix uses the same solution as in `OpenSAML` and replaces
`CleanerSupport` with our custom implementation `CleanerFactory`.

Signed-off-by: Andrey Pleskach <[email protected]>
(cherry picked from commit 44a03c5)
Signed-off-by: Andrey Pleskach <[email protected]>
willyborankin added a commit to willyborankin/security that referenced this pull request Nov 30, 2023
)

In order to exclude `permission
org.opensearch.secure_sm.ThreadPermission "modifyArbitraryThread";` we
must use the dedicated `cleaners` thread factory in `OpenSearch`. Since
`OpenSAML` packages are sealed it it impossible to replace
`CleanerSupport` class with our own solution. Instead we have to change
configuration of how such objects should be parsed. There are only 2
classes in the library which use `CleanerSupport`:
 - `X509CertificateImpl`
 - `X509CRLImpl`

This fix uses the same solution as in `OpenSAML` and replaces
`CleanerSupport` with our custom implementation `CleanerFactory`.

Signed-off-by: Andrey Pleskach <[email protected]>
(cherry picked from commit 44a03c5)
Signed-off-by: Andrey Pleskach <[email protected]>
cwperks pushed a commit that referenced this pull request Dec 6, 2023
Backported PRs:
- #2987
- #2927
- #3651
- #3690 
into 2.x

---------

Signed-off-by: Andrey Pleskach <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x backport to 2.x branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants