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

doc updates to include new fields for SAML sig validation #29195

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

himran92
Copy link

@himran92 himran92 commented Dec 16, 2024

Description

Updating docs for incoming SAML changes in PR for new options for strict SAML validation.

TODO only if you're a HashiCorp employee

  • Backport Labels: If this fix needs to be backported, use the appropriate backport/ label that matches the desired release branch. Note that in the CE repo, the latest release branch will look like backport/x.x.x, but older release branches will be backport/ent/x.x.x+ent.
    • LTS: If this fixes a critical security vulnerability or severity 1 bug, it will also need to be backported to the current LTS versions of Vault. To ensure this, use all available enterprise labels.
  • ENT Breakage: If this PR either 1) removes a public function OR 2) changes the signature
    of a public function, even if that change is in a CE file, double check that
    applying the patch for this PR to the ENT repo and running tests doesn't
    break any tests. Sometimes ENT only tests rely on public functions in CE
    files.
  • Jira: If this change has an associated Jira, it's referenced either
    in the PR description, commit message, or branch name.
  • RFC: If this change has an associated RFC, please link it in the description.
  • ENT PR: If this change has an associated ENT PR, please link it in the
    description. Also, make sure the changelog is in this PR, not in your ENT PR.

@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Dec 16, 2024
Copy link

CI Results:
All Go tests succeeded! ✅

@himran92 himran92 marked this pull request as ready for review December 16, 2024 19:37
@himran92 himran92 requested a review from a team as a code owner December 16, 2024 19:37
fairclothjm
fairclothjm previously approved these changes Dec 16, 2024
@@ -51,6 +51,15 @@ Configures the auth method with a SAML identity provider.
according to the current logging level. When `verbose_logging` is `true`,
debug-level logs provide user attributes and trace-level logs provide the full
SAML response.
- `validate_response_and_assertion_signatures` `(bool, false)` - Enables validation
of signatures for both response and assertion in the SAML response. If IDP allows
signing both response and assertion then **recommendation** is to opt for this option.
Copy link
Contributor

@yhyakuna yhyakuna Dec 17, 2024

Choose a reason for hiding this comment

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

Is the recommendation is to opt in?

Suggested change
signing both response and assertion then **recommendation** is to opt for this option.
signing both response and assertion, then **recommendation** is to opt in for this option.

Copy link
Author

Choose a reason for hiding this comment

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

removed the validate_response_and_assertion_signatures option

signing both response and assertion then **recommendation** is to opt for this option.
- `validate_response_signature` `(bool, false)` - Enables validation of signature
for at least response in the SAML response. If IDP allows signing both response
and assertion then recommendation is to opt for validating signatures of both.
Copy link
Contributor

Choose a reason for hiding this comment

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

Same question. Should this be opt in?

Suggested change
and assertion then recommendation is to opt for validating signatures of both.
and assertion, then recommendation is to opt in for validating signatures of both.

Copy link
Author

Choose a reason for hiding this comment

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

added opt in

and assertion then recommendation is to opt for validating signatures of both.
- `validate_assertion_signature` `(bool, false)` - Enables validation of signature
for at least assertion in the SAML response. If IDP allows signing both response
and assertion then recommendation is to opt for validating signatures of both.
Copy link
Contributor

Choose a reason for hiding this comment

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

Same question. Should this be opt in?

Suggested change
and assertion then recommendation is to opt for validating signatures of both.
and assertion, then recommendation is to opt in for validating signatures of both.

Copy link
Author

Choose a reason for hiding this comment

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

added opt in

Copy link

Build Results:
All builds succeeded! ✅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed pr/no-changelog pr/no-milestone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants