-
Notifications
You must be signed in to change notification settings - Fork 389
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
docs: add device flow documentation #2026
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks so much, this already looks great!
left a couple of comments to bring the doc in line with our docs style guide.
content wise this looks very good - I did not test it out in practice though
as for the place of the doc and also place in the sidebar we can check what the best place is once its ready to merge. @christiannwamba is currently working on a restructure of the docs, so depending on when its ready to merge we might have a different place for it. |
Thanks for the review @vinckr. I think I applied all of the requested changes, please have another look when you can. |
da5525d
to
7acc1cb
Compare
We should probably add to the oauth2 quickstart this command chain as well, to try it out quickly:
Of course not with go run . but with the ory cli prefix. We'll need to release that then first and can then merge the docs, which also kinda makes sense as we need to release this stuff in any case before merging it as it would be confusing to users/customers |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like there were some merge conflicts incorrectly addressed, can you please revert all non-relevant changes for this PR?
This patch introduces the OAuth 2.0 Device Authorization Grant to Ory Hydra. The OAuth 2.0 device authorization grant is designed for Internet-connected devices that either lack a browser to perform a user-agent-based authorization or are input constrained to the extent that requiring the user to input text in order to authenticate during the authorization flow is impractical. It enables OAuth clients on such devices (like smart TVs, media consoles, digital picture frames, and printers) to obtain user authorization to access protected resources by using a user agent on a separate device. The OAuth 2.0 Device Authorization Grant may also become relevant for AI Agent authentication flows and is generally an amazing step and innovation for this project. A very special thanks goes to @nsklikas from [Canonical](https://canonical.com), @supercairos from [shadow.tech](https://shadow.tech) and @BuzzBumbleBee. For more details, please check out the documentation (ory/docs#2026) To implement this feature, you will need to implement two additional screens in your login and consent application. A reference implementation can be found [here](https://github.com/ory/hydra-login-consent-node/blob/99ca6ad544f64110706c289dda74c7c622ec3110/src/routes/device.ts). Closes #3851 Closes #3252 Closes #3230 Closes #2416
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is looking great from my POV.
some "nits" that might improve readability, feel free to include or not.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm 🚀
thanks so much 🫶
Related Issue or Design Document
Adds docs for the device flow as implemented in ory/hydra#3912.
Checklist
If this pull request addresses a security vulnerability,
I confirm that I got approval (please contact [email protected]) from the maintainers to push the changes.
Further comments
I am not sure if this is the right place to place the doc, The rest of the docs in that folder do not reference hydra configurations, but the docs in the hydra folder do not seem to document oauth2/oidc flows. Please let me know if there is a better place for it.