ccc6601ff3
Beyond simply moving to the builder pattern for intialization this has a few other effects. The DeviceFlow and InstalledFlow can no longer be used without an associated Authenticator. This is becaus they no longer have any publicly accessible constructor. All initialization goes through the Authenticator. This also means that the flows are always initialized with a clone of the hyper client used by the Authenticator. The authenticator uses the builder pattern which allows omitting optional fields. This means that if users simply want a default hyper client, they don't need to create one explicitly. One will be created automatically. If users want to specify a hyper client (maybe to allow sharing a single client between different libraries) they can still do so by using the hyper_client method on the builder. Additionally for both AuthenticatorDelegate's and FlowDelegate's if the user does not specify an override the default ones will be used. The builders are now exposed publicly with the names of Authenicator, InstalledFlow, and DeviceFlow. The structs that actually implement those behaviors are now hidden and only expose the GetToken trait. This means some methods that were previously publicly accessible are no longer available, but the methods appeared to be implementation details that probably shouldn't have been exposed anyway.
yup-oauth2 is a utility library which implements several OAuth 2.0 flows. It's mainly used by google-apis-rs, to authenticate against Google services. (However, you're able to use it with raw HTTP requests as well; the flows are implemented as token sources yielding HTTP Bearer tokens).
The provider we have been testing the code against is also Google. However, the code itself is generic, and any OAuth provider behaving like Google will work as well. If you find one that doesn't, please let us know and/or contribute a fix!
Supported authorization types
- Device flow (user enters code on authorization page)
- Installed application flow (user visits URL, copies code to application, application uses code to obtain token). Used for services like GMail, Drive, ...
- Service account flow: Non-interactive authorization of server-to-server communication based on public key cryptography. Used for services like Cloud Pubsub, Cloud Storage, ...
Usage
Please have a look at the API landing page for all the examples you will ever need.
A simple commandline program which authenticates any scope and prints token information can be found in the examples directory.
The video below shows the auth example in action. It's meant to be used as utility to record all server communication and improve protocol compliance.
Versions
Version 1.x for Hyper versions bellow 12 Version 2.x for Hyper versions 12 and above
License
Licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.