Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ueberauth/ueberauth_identity
A username/password Strategy for Überauth
https://github.com/ueberauth/ueberauth_identity
identity strategy ueberauth ueberauth-strategies
Last synced: about 2 months ago
JSON representation
A username/password Strategy for Überauth
- Host: GitHub
- URL: https://github.com/ueberauth/ueberauth_identity
- Owner: ueberauth
- License: mit
- Created: 2015-11-09T18:10:56.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-07-08T20:59:06.000Z (about 2 years ago)
- Last Synced: 2024-07-09T01:36:56.182Z (2 months ago)
- Topics: identity, strategy, ueberauth, ueberauth-strategies
- Language: Elixir
- Homepage:
- Size: 44.9 KB
- Stars: 79
- Watchers: 7
- Forks: 21
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- fucking-awesome-elixir - ueberauth_identity - A simple username/password strategy for Überauth. (Authentication)
- awesome-elixir - ueberauth_identity - A simple username/password strategy for Überauth. (Authentication)
- freaking_awesome_elixir - Elixir - A simple username/password strategy for Ãberauth. (Authentication)
README
# Üeberauth Identity
[](https://travis-ci.org/ueberauth/ueberauth_identity)
[](https://hex.pm/packages/ueberauth)
[](https://hexdocs.pm/ueberauth/)
[](https://hex.pm/packages/ueberauth)
[](https://github.com/ueberauth/ueberauth/blob/master/LICENSE)
[](https://github.com/ueberauth/ueberauth/commits/master)
> A simple username/password strategy for Überauth.
## Installation
1. Add `:ueberauth_identity` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:ueberauth_identity, "~> 0.3"}
]
end
```
2. Add the strategy to your applications:
```elixir
def application do
[
applications: [:ueberauth_identity]
]
end
```
3. Add Identity to your Überauth configuration:
```elixir
config :ueberauth, Ueberauth,
providers: [
identity: {Ueberauth.Strategy.Identity, [
callback_methods: ["POST"]
]}
]
```
4. Include the Überauth plug in your controller:
```elixir
defmodule MyApp.AuthController do
use MyApp.Web, :controller
plug Ueberauth
...
end
```
5. 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
post "/identity/callback", AuthController, :identity_callback
end
```
6. Your request phase handler should implement a form or similar method to collect the required login information.
7. The controller callback should validate login information using the `Ueberauth.Auth` struct:
```elixir
def identity_callback(%{assigns: %{ueberauth_auth: auth}} = conn, params) do
case validate_password(auth.credentials) do
:ok ->
user = %{id: auth.uid, name: name_from_auth(auth), avatar: auth.info.image}
conn
|> put_flash(:info, "Successfully authenticated.")
|> put_session(:current_user, user)
|> redirect(to: "/")
{ :error, reason } ->
conn
|> put_flash(:error, reason)
|> redirect(to: "/")
end
end
```
For an example implementation see the [Überauth Example](https://github.com/ueberauth/ueberauth_example) application.
## Nested form attributes
Sometimes it's convenient to nest the returned params under a namespace. For
example if you're using a "user" form, your params may come back as:
```elixir
%{ "user" => { "email" => "[email protected]" … }
```
If you're using a nested set of attributes like this you'll need to let
Überauth Identity know about it. To do this set an option in your config:
```elixir
config :ueberauth, Ueberauth,
providers: [
identity: {Ueberauth.Strategy.Identity, [param_nesting: "user"]}
]
```
## Params scrubbing
By default Überauth Identity will be changing empty values from the returned
params to nil.
If you want to disable that behaviour set the following option in your config:
```elixir
config :ueberauth, Ueberauth,
providers: [
identity: {Ueberauth.Strategy.Identity, [scrub_params: false]}
]
```
## Calling
Depending on the configured url you can initial the request through:
/auth/identity/callback
## Copyright and License
Copyright (c) 2015 Daniel Neighman
Released under the MIT License, which can be found in the repository in [LICENSE](./LICENSE).