ueberauth_hpid

defmodule Ueberauth.Strategy.HPID do
  @moduledoc """
  Provides an Ueberauth strategy for authenticating with HP ID.

  ### Setup

  Include the provider in your configuration for Ueberauth

      config :ueberauth, Ueberauth,
        providers: [
          hpid: { Ueberauth.Strategy.HPID, [] }
        ]

  Then include the configuration for HP ID.

      config :ueberauth, Ueberauth.Strategy.HPID.OAuth,
        client_id: System.get_env("HPID_CLIENT_ID"),
        client_secret: System.get_env("HPID_CLIENT_SECRET")

  If you haven't already, create a pipeline and setup routes for your callback handler

      pipeline :auth do
        Ueberauth.plug "/auth"
      end

      scope "/auth" do
        pipe_through [:browser, :auth]

        get "/:provider/callback", AuthController, :callback
      end


  Create an endpoint for the callback where you will handle the `Ueberauth.Auth` struct

      defmodule MyApp.AuthController do
        use MyApp.Web, :controller

        def callback_phase(%{ assigns: %{ ueberauth_failure: fails } } = conn, _params) do
          # do things with the failure
        end

        def callback_phase(%{ assigns: %{ ueberauth_auth: auth } } = conn, params) do
          # do things with the auth
        end
      end

  You can edit the behaviour of the Strategy by including some options when you register your provider.

  To set the default 'scopes' (permissions):

      config :ueberauth, Ueberauth,
        providers: [
          hpid: { Ueberauth.Strategy.HPID, [default_scope: "openid+profile+email"] }
        ]

  Default is empty ("openid+profile+email") which "Grants read-only access to profile information"
  """
  use Ueberauth.Strategy,
    default_scope: "openid+profile+email",
    oauth2_module: Ueberauth.Strategy.HPID.OAuth

  alias Ueberauth.Auth.Info
  alias Ueberauth.Auth.Credentials
  alias Ueberauth.Auth.Extra

  @doc """
  Handles the initial redirect to the HP ID authentication page.

  To customize the scope (permissions) that are requested by hpid include them as part of your url:

      "/auth/hpid?scope=openid+profile+email"

  You can also include a `state` param that hpid will return to you.
  """
  def handle_request!(conn) do
    scopes = conn.params["scope"] || option(conn, :default_scope)
    send_redirect_uri = Keyword.get(options(conn), :send_redirect_uri, true)

    opts =
      if send_redirect_uri do
        [redirect_uri: callback_url(conn), scope: scopes]
      else
        [scope: scopes]
      end

    opts =
      if conn.params["state"], do: Keyword.put(opts, :state, conn.params["state"]), else: opts

    module = option(conn, :oauth2_module)
    redirect!(conn, apply(module, :authorize_url!, [opts]))
  end

  @doc """
  Handles the callback from HP ID. When there is a failure from HP ID the failure is included in the
  `ueberauth_failure` struct. Otherwise the information returned from HP ID is returned in the `Ueberauth.Auth` struct.
  """
  def handle_callback!(%Plug.Conn{params: %{"code" => code}} = conn) do
    send_redirect_uri = Keyword.get(options(conn), :send_redirect_uri, true)

    opts =
      if send_redirect_uri do
        [redirect_uri: callback_url(conn), code: code]
      else
        [code: code]
      end

    module = option(conn, :oauth2_module)
    token = apply(module, :get_token!, [opts])

    if token.access_token == nil do
      set_errors!(conn, [
        error(token.other_params["error"], token.other_params["error_description"])
      ])
    else
      fetch_user(conn, token)
    end
  end

  @doc """
  Handles a callback from the client when using the Token
  Flow. In this case, the client requests a code, then exchanges it
  for the jwt token. We just need to verify the jwt token with HP ID.
  """
  def handle_callback!(%Plug.Conn{params: %{"access_token" => access_token}} = conn) do
    token = OAuth2.AccessToken.new(access_token)

    # verify that the access token's aud matches our client id
    if check_access_token(conn, token) do
      fetch_user(conn, token)
    else
      set_errors!(conn, [error("token", "Token verification failed")])
    end
  end

  @doc false
  def handle_callback!(conn) do
    set_errors!(conn, [error("missing_code", "No code received")])
  end

  @doc """
  Cleans up the private area of the connection used for passing the raw HP ID response around during the callback.
  """
  def handle_cleanup!(conn) do
    conn
    |> put_private(:hpid_user, nil)
    |> put_private(:hpid_token, nil)
  end

  @doc """
  Fetches the uid field from the HP ID response. This defaults to the option `uid_field` which in-turn defaults to `id`
  """
  def uid(conn) do
    conn |> option(:uid_field) |> to_string() |> fetch_uid(conn)
  end

  @doc """
  Includes the credentials from the HP ID response.
  """
  def credentials(conn) do
    token = conn.private.hpid_token
    scope_string = token.other_params["scope"] || ""
    scopes = String.split(scope_string, ",")

    %Credentials{
      token: token.access_token,
      refresh_token: token.refresh_token,
      expires_at: token.expires_at,
      token_type: token.token_type,
      expires: !!token.expires_at,
      scopes: scopes
    }
  end

  @doc """
  Fetches the fields to populate the info section of the `Ueberauth.Auth` struct.
  """
  def info(conn) do
    user = conn.private.hpid_user

    %Info{
      name: user["name"],
      first_name: user["given_name"],
      last_name: user["family_name"],
      nickname: user["sub"],
      email: user["email"]
    }
  end

  @doc """
  Stores the raw information (including the token) obtained from the HP ID callback.
  """
  def extra(conn) do
    %Extra{
      raw_info: %{
        token: conn.private.hpid_token,
        user: conn.private.hpid_user
      }
    }
  end

  @doc """
  Verify the access token with HP ID.
  It is especially important to verify the
  aud matches our client_id
  """
  def check_access_token(conn, token) do
    module = option(conn, :oauth2_module)
    apply(module, :validate, [token])
  end

  defp fetch_uid("email", %{private: %{hpid_user: user}}) do
    # private email will not be available as :email and must be fetched
    fetch_email!(user)
  end

  defp fetch_uid(field, conn) do
    conn.private.hpid_user[field]
  end

  defp fetch_email!(user) do
    user["email"]
  end

  defp fetch_user(conn, token) do
    conn = put_private(conn, :hpid_token, token)

    case Ueberauth.Strategy.HPID.OAuth.get(token, "/directory/v1/userinfo") do
      {:ok, %OAuth2.Response{status_code: 401, body: _body}} ->
        set_errors!(conn, [error("token", "unauthorized")])

      {:ok, %OAuth2.Response{status_code: status_code, body: user}}
      when status_code in 200..399 ->
        put_private(conn, :hpid_user, user)

      {:error, %OAuth2.Error{reason: reason}} ->
        set_errors!(conn, [error("OAuth2", reason)])
    end
  end

  defp option(conn, key) do
    Keyword.get(options(conn), key, Keyword.get(default_options(), key))
  end
end