Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ueberauth/ueberauth_google
Google OAuth2 Strategy for Überauth.
https://github.com/ueberauth/ueberauth_google
google oauth oauth2 strategy ueberauth ueberauth-strategies
Last synced: 4 days ago
JSON representation
Google OAuth2 Strategy for Überauth.
- Host: GitHub
- URL: https://github.com/ueberauth/ueberauth_google
- Owner: ueberauth
- License: mit
- Created: 2015-11-17T01:32:28.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-02-22T15:01:01.000Z (9 months ago)
- Last Synced: 2024-10-02T06:42:42.697Z (about 1 month ago)
- Topics: google, oauth, oauth2, strategy, ueberauth, ueberauth-strategies
- Language: Elixir
- Homepage:
- Size: 101 KB
- Stars: 165
- Watchers: 11
- Forks: 85
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- fucking-awesome-elixir - ueberauth_google - A Google strategy for Überauth. (Authentication)
- awesome-elixir - ueberauth_google - A Google strategy for Überauth. (Authentication)
- freaking_awesome_elixir - Elixir - A Google strategy for Ãberauth. (Authentication)
README
# Überauth Google
[](https://github.com/ueberauth/ueberauth_google/actions/workflows/ci.yml)
[](https://travis-ci.org/ueberauth/ueberauth_google)
[](https://hex.pm/packages/ueberauth_google)
[](https://hexdocs.pm/ueberauth_google/)
[](https://hex.pm/packages/ueberauth_google)
[](https://github.com/ueberauth/ueberauth_google/blob/master/LICENSE)
[](https://github.com/ueberauth/ueberauth_google/commits/master)
> Google OAuth2 strategy for Überauth.
## Installation
1. Setup your application at [Google Developer Console](https://console.developers.google.com/home).
2. Add `:ueberauth_google` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:ueberauth_google, "~> 0.10"}
]
end
```
3. Add Google to your Überauth configuration:
```elixir
config :ueberauth, Ueberauth,
providers: [
google: {Ueberauth.Strategy.Google, []}
]
```
4. Update your provider configuration:
Use that if you want to read client ID/secret from the environment
variables in the compile time:
```elixir
config :ueberauth, Ueberauth.Strategy.Google.OAuth,
client_id: System.get_env("GOOGLE_CLIENT_ID"),
client_secret: System.get_env("GOOGLE_CLIENT_SECRET")
```
Use that if you want to read client ID/secret from the environment
variables in the run time:
```elixir
config :ueberauth, Ueberauth.Strategy.Google.OAuth,
client_id: {System, :get_env, ["GOOGLE_CLIENT_ID"]},
client_secret: {System, :get_env, ["GOOGLE_CLIENT_SECRET"]}
```
5. Include the Überauth plug in your controller:
```elixir
defmodule MyApp.AuthController do
use MyApp.Web, :controller
plug Ueberauth
...
end
```
6. Create the request and callback routes if you haven't already:
```elixir
scope "/auth", MyApp do
pipe_through :browser
get "/:provider", AuthController, :request
get "/:provider/callback", AuthController, :callback
end
```
7. Your controller needs to implement callbacks to deal with `Ueberauth.Auth` and `Ueberauth.Failure` responses.
For an example implementation see the [Überauth Example](https://github.com/ueberauth/ueberauth_example) application.
## Calling
Depending on the configured url you can initiate the request through:
/auth/google
Or with options:
/auth/google?scope=email%20profile
By default the requested scope is "email". Scope can be configured either explicitly as a `scope` query value on the request path or in your configuration:
```elixir
config :ueberauth, Ueberauth,
providers: [
google: {Ueberauth.Strategy.Google, [default_scope: "email profile plus.me"]}
]
```
You can also pass options such as the `hd` parameter to suggest a particular Google Apps hosted domain (caution, can still be overridden by the user), `prompt` and `access_type` options to request refresh_tokens and offline access (both have to be present), or `include_granted_scopes` parameter to allow [incremental authorization](https://developers.google.com/identity/protocols/oauth2/web-server#incrementalAuth).
```elixir
config :ueberauth, Ueberauth,
providers: [
google: {Ueberauth.Strategy.Google, [hd: "example.com", prompt: "select_account", access_type: "offline", include_granted_scopes: true]}
]
```
In some cases, it may be necessary to update the user info endpoint, such as when deploying to countries that block access to the default endpoint.
```elixir
config :ueberauth, Ueberauth,
providers: [
google: {Ueberauth.Strategy.Google, [userinfo_endpoint: "https://www.googleapis.cn/oauth2/v3/userinfo"]}
]
```
This may also be set via runtime configuration by passing a 2 or 3 argument tuple. To use this feature, the first argument must be the atom `:system`, and the second argument must represent the environment variable containing the endpoint url.
A third argument may be passed representing a default value if the environment variable is not found, otherwise the library default will be used.
```elixir
config :ueberauth, Ueberauth,
providers: [
google: {Ueberauth.Strategy.Google, [
userinfo_endpoint: {:system, "GOOGLE_USERINFO_ENDPOINT", "https://www.googleapis.cn/oauth2/v3/userinfo"}
]}
]
```
To guard against client-side request modification, it's important to still check the domain in `info.urls[:website]` within the `Ueberauth.Auth` struct if you want to limit sign-in to a specific domain.
## Copyright and License
Copyright (c) 2015 Sean Callan
Released under the MIT License, which can be found in the repository in [LICENSE](https://github.com/ueberauth/ueberauth_google/blob/master/LICENSE).