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

Add oidc callback mode that is direct to server #318

Merged
merged 1 commit into from
Jul 17, 2024

Conversation

DrDaveD
Copy link
Contributor

@DrDaveD DrDaveD commented May 3, 2024

This adds a new option to the oidc auth method role option called callback_mode. When set to direct it enables the callback from the Authorization Server to be direct to bao instead of to the client. This allows clients from multiple users to share a machine because they do not need to share a port to listen on, and it also makes for easier management of firewalls, etc, because only the bao server needs to be configured to accept connections from the Authorization Server instead of every client.

When callback_mode=direct is set, the oidc/auth_url client API returns additional parameters 'state' and 'poll_interval'. The client is then expected to call a new API oidc/poll (instead of oidc/callback) and try again every poll_interval seconds while the response is an http 400 error authorization_pending. When the Authorization Server instead calls the oidc/callback api, the response is in html because it goes to the user's web browser, and the authorization information is stored in the state entry until the next call to oidc/poll.

The cli also has a new option callbackmode=direct (without an underscore) to apply different defaults for the redirect_uri parameter, based on the $VAULT_ADDR environment variable. That is a convenience and is not strictly necessary in order to make it work. When there is a state in the response to the oidc/auth_url API, instead of starting a listener the client calls back to oidc/poll every poll_interval seconds.

cli_responses.go is renamed to html_responses.go because it's not used exclusively for cli (and in fact it already wasn't).

Essentially the same PR has been pending in hashicorp/vault-plugin-auth-jwt#130 for several years, and although several other people expressed an interest in it, no action has been taken to merge it yet there. It has been in production use for a couple of years through https://github.com/fermitools/htvault-config.

Copy link
Member

@cipherboy cipherboy left a comment

Choose a reason for hiding this comment

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

Thanks for this, it is looking fairly comprehensive @DrDaveD! One thing missing that I see off the top of my head are doc updates?

builtin/credential/jwt/path_oidc.go Show resolved Hide resolved
builtin/credential/jwt/path_role_test.go Show resolved Hide resolved
builtin/credential/jwt/path_role.go Show resolved Hide resolved
builtin/credential/jwt/cli.go Outdated Show resolved Hide resolved
builtin/credential/jwt/cli.go Show resolved Hide resolved
builtin/credential/jwt/cli.go Show resolved Hide resolved
builtin/credential/jwt/path_oidc.go Show resolved Hide resolved
builtin/credential/jwt/path_oidc.go Show resolved Hide resolved
@DrDaveD
Copy link
Contributor Author

DrDaveD commented May 19, 2024

Thanks for all the detailed comments. This is just to tell you that I won't be able to look at them closely this week, but should be able to the following week.

@DrDaveD
Copy link
Contributor Author

DrDaveD commented May 30, 2024

I was waiting to write the docs until I had interest shown that the PR would be accepted. I have updated the docs now but am waiting to commit until I do some more testing.

@DrDaveD DrDaveD marked this pull request as draft May 30, 2024 21:39
@DrDaveD
Copy link
Contributor Author

DrDaveD commented May 30, 2024

I decided to go ahead and push it as-is but mark the PR as draft for now until I am able to do further testing

@DrDaveD DrDaveD marked this pull request as ready for review June 7, 2024 20:15
@DrDaveD
Copy link
Contributor Author

DrDaveD commented Jun 7, 2024

I fixed the crash that I mentioned in the status meeting yesterday; it was in the code of this PR. This is now ready for re-review.

@cipherboy cipherboy added this to the 2.0.0 - GA milestone Jun 15, 2024
Copy link
Member

@cipherboy cipherboy left a comment

Choose a reason for hiding this comment

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

This looks good, thank @DrDaveD! I'd probably wait until after Beta to merge this though.

@cipherboy
Copy link
Member

@DrDaveD Do you mind rebasing this? I have consensus to merge ahead of GA from Dan &co, but I think test-go (10) was failing due to an earlier fix we've merged. Thanks!

@DrDaveD
Copy link
Contributor Author

DrDaveD commented Jul 10, 2024

@cipherboy it is rebased. The "Vulnerable dependencies" CI failure do not look to be related.

@cipherboy
Copy link
Member

Ah, one last thing -- mind if I bother you to do GPG/SSH signing of commits? Dan was in favor of leaving that enabled on our last community call so for now we'll enforce it, but going forward we might think about changing the requirements if you have thoughts either way. :-)

Thanks and sorry!

Signed-off-by: Dave Dykstra <2129743+DrDaveD@users.noreply.github.com>
@DrDaveD
Copy link
Contributor Author

DrDaveD commented Jul 11, 2024

@cipherboy It looks like I managed to figure out how to automate it using ssh. However there are more CI tests failing that are unrelated.

@cipherboy cipherboy removed this from the 2.0.0 - GA milestone Jul 16, 2024
@cipherboy
Copy link
Member

Perfect, thanks @DrDaveD! And apologies, we opted on the last community call to stabilize the release and wait on pending PRs; I've merged this for the next release (which I'm tentatively calling v2.1.0 but we'll see what the community decides tomorrow).

@cipherboy cipherboy merged commit bd5b82b into openbao:main Jul 17, 2024
53 of 54 checks passed
@cipherboy cipherboy added this to the 2.1.0 - Beta milestone Jul 17, 2024
@DrDaveD DrDaveD deleted the oidc-code-flow-to-server branch July 18, 2024 13:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants