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

api: add override mechanism for SOAP Header.Cookie #3636

Merged
merged 1 commit into from
Dec 11, 2024

Conversation

dougm
Copy link
Member

@dougm dougm commented Dec 5, 2024

Sessions are consumed by API endpoints via one of:

  • HTTP Cookie (vim25 for example)
  • HTTP Header (vmodl2 /rest and /api)
  • SOAP Header (pbm, vslm, sms for example)

The soap.Client had always set the SOAP Header cookie regardless if consumed by an API endpoint.
Clients must now opt-in to this behavior if they need it, such as pbm and vslm.

This also allows clients to change the name of soap.Header.Cookie (default is still "vcSessionCookie")

vcsim: add override mechanism for session mapping

On the simulator side, API endpoints can specify where a session is sourced from. Default is still the "vmware_soap_session" HTTP Cookie. The pbm simulator now specifies the "vcSessionCookie" SOAP Header, behaving as real pbm/VC does.

@dougm dougm requested a review from akutz December 5, 2024 00:21
akutz
akutz previously approved these changes Dec 6, 2024
Copy link
Member

@akutz akutz left a comment

Choose a reason for hiding this comment

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

Lgtm. Left one comment.

@dougm dougm force-pushed the cookie-auth branch 2 times, most recently from be1221b to 3cfeaaa Compare December 6, 2024 19:45
Sessions are consumed by API endpoints via one of:
- HTTP Cookie (vim25 for example)
- HTTP Header (vmodl2 /rest and /api)
- SOAP Header (pbm, vslm, sms for example)

The soap.Client had always set the SOAP Header cookie regardless if consumed by an API endpoint.
Clients must now opt-in to this behavior if they need it, such as pbm and vslm.

This also allows clients to change the name of soap.Header.Cookie (default is still "vcSessionCookie")

vcsim: add override mechanism for session mapping

On the simulator side, API endpoints can specify where a session is sourced from.
Default is still the "vmware_soap_session" HTTP Cookie.
The pbm simulator now specifies the "vcSessionCookie" SOAP Header, behaving as real pbm/VC does.

Signed-off-by: Doug MacEachern <dougm@broadcom.com>
@akutz akutz self-requested a review December 11, 2024 16:09
Copy link
Member

@akutz akutz left a comment

Choose a reason for hiding this comment

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

Thanks Doug!

@dougm dougm merged commit 84d6438 into vmware:main Dec 11, 2024
11 checks passed
@dougm dougm deleted the cookie-auth branch December 11, 2024 17:47
dougm added a commit to dougm/govmomi that referenced this pull request Jan 7, 2025
In 1918984 / PR vmware#3636 we deferred the http.CookieJar lookup
until request time. Fallback to using Path="/" if initial lookup fails.

Signed-off-by: Doug MacEachern <dougm@broadcom.com>
dougm added a commit that referenced this pull request Jan 7, 2025

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
In 1918984 / PR #3636 we deferred the http.CookieJar lookup
until request time. Fallback to using Path="/" if initial lookup fails.

Signed-off-by: Doug MacEachern <dougm@broadcom.com>
Copy link
Contributor

I'm going to lock this pull request because it has been closed for 30 days. This helps our maintainers find and focus on the active issues.

If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 17, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants