Setting up OAuth in Phoenix

So, it’s been like a month since I started learning Elixir and the Phoenix. Phoenix is a web framework powered by Elixir and the Erlang VM, which makes it fast.

In this post, we will see setting up “Sign in With Google” in a Phoenix application with Ueberauth . We will be using the ueberauth_google hex package to perform this.

I’m going to assume that you have created the Phoenix app and created a user model. It should look similar to this.

1
schema "users" do
2
    field :email, :string
3
    field :first_name, :string
4
    field :last_name, :string
5
    field :provider, :string
6
    field :picture, :string
7

8
    timestamps()
9
  end

Adding Dependencies

We will add the ueberauth_google dependency to the deps in the mix.exs. Now, the mix.ex file looks like this.

1
 defp deps do
2
    [
3
      {:phoenix, "~> 1.5.3"},
4
      {:phoenix_ecto, "~> 4.1"},
5
      {:ecto_sql, "~> 3.4"},
6
      {:postgrex, ">= 0.0.0"},
7
      {:phoenix_live_view, "~> 0.13.0"},
8
      {:floki, ">= 0.0.0", only: :test},
9
      {:phoenix_html, "~> 2.11"},
10
      {:phoenix_live_reload, "~> 1.2", only: :dev},
11
      {:phoenix_live_dashboard, "~> 0.2.0"},
12
      {:telemetry_metrics, "~> 0.4"},
13
      {:telemetry_poller, "~> 0.4"},
14
      {:gettext, "~> 0.11"},
15
      {:jason, "~> 1.0"},
16
      {:plug_cowboy, "~> 2.0"},
17
      {:ueberauth_google, "~> 0.9"}
18
    ]
19
end

Next we need to include this in the application function in the mix.exs. Now the application function looks like,

1
def application do
2
    [
3
      mod: {OAuthApp.Application, []},
4
      extra_applications: [:logger, :runtime_tools, :ueberauth_google],
5
    ]
6
end

After this run the following command to install the added dependencies. This will show the entire dependencies list including the ones we added now.

1
> mix deps.get

Create a Google Project

Create a Google project by following the steps given here . The Google app will generate the client_id and client_secret that we need to configure in our app. In the Google app configurations, set the redirect_uri as “ http://localhost:4000/auth/google/callback /”.

Updating Configurations

We will now add the configuration of our google app in our Phoenix application. Add the client id, client secret, and redirect_uri to the config.exs file.

1
# Ueberauth Config
2
config :ueberauth, Ueberauth,
3
  providers: [
4
    google: {Ueberauth.Strategy.Google, [default_scope: "email profile"]}
5
  ]
6
config :ueberauth, Ueberauth.Strategy.Google.OAuth,
7
  client_id: "741231234148352289-e9asdasdmomm9lar1brbundnmfg3j80f04ntqt.apps.googleusercontent.com", # Dummy code
8
  client_secret: "33uWw8WnPsadsdsSas7rjaTnkYbwu6", # Dummy code
9
  redirect_uri: "http://localhost:4000/auth/google/callback"

Now we have done all the configurations needed, we will get into coding now.

Defining the Routes

We will add the routes for sign in with google. We need the define the following routes in the routes.ex:

• OAuth Initiate - This initiates the OAuth process.
• OAuth Callback - This route is the route defined as redirect_uri in the google app configuration. We will get the user details in this callback call.

We will add these routes with the scope “/auth”. The code to be added to the router.ex looks like where provide is Google here. We can also use the same routes for any other social sign we need.

1
scope "/auth", OAuthApp do
2
    pipe_through :browser
3

4
    get "/:provider", AuthController, :request
5
    get "/:provider/callback", AuthController, :callback
6
  end

Auth Controller

We will now create a controller to handle the OAuth process.

• Inside the controllers folder, create a controller file called auth_controller.ex. We will define the callback function here.
• We need to define two callback functions.
  • OAuth Success Case
  • OAuth Failure Case

OAuth Failure Case

The Ueberauth send the failure response in the below mentioned format. So, we need to define a callback function to match the failure pattern. If the “assigns” variable has the key “ueberauth_failure”, it indicates that the authorization failed.

1
def callback(%{assigns: %{ueberauth_failure: _fails}}:conn, _params) do
2
    conn
3
    |> put_flash(:error, "Failed to authenticate.")
4
    |> redirect(to: "/")
5
  end

OAuth Success Case

If the failure key is not present then the authorization is successful and it sends the oauth response in the key “ueberauth_auth” in the response. So, we need to define the callback function to match the response pattern.

Like in the code below, we can match the user information and send it to the user changeset and based on the use case either create or update the user details.

1
def callback(%{assigns: %{ueberauth_auth: auth}}:conn, _params) do
2
    user_params:%{
3
      first_name: auth.info.first_name,
4
      last_name: auth.info.last_name,
5
      email: auth.info.email,
6
      picture: auth.info.image,
7
      provider: "google"
8
    }
9

10
    changeset:User.changeset(%User{}, user_params)
11

12
    case insert_or_update_user(changeset) do
13
      {:ok, user} ->
14
        conn
15
        |> put_flash(:info, "Thank you for signing in!")
16
        |> put_session(:user_id, user.id)
17
        |> redirect(to: Routes.lobby_path(conn, :index))
18

19
      {:error, _reason} ->
20
        conn
21
        |> put_flash(:error, "Error signing in")
22
        |> redirect(to: Routes.page_path(conn, :index))
23
    end
24
  end

Yay! Now, you have successfully used Google OAuth to authenticate your users.

In this article, we discussed implementing Sign in with Google in our Phoenix application. Ueberauth provides OAuth for most of the social platforms such as Facebook, Twitter. WIth this we can also get the user token from the OAuth response and play with the Google APi to integrate google apps like Google Calendar, Google Meet. With this, the user does not have to remember a password which gives a good user experience.

If you find any difficulties, reach out to [email protected] .