ueberauth_gitlab_strategy v0.4.0 Ueberauth.Strategy.Gitlab View Source

Provides an Ueberauth strategy for authenticating with Gitlab.

Setup

Create an application in Gitlab for you to use.

Include the provider in your configuration for Ueberauth

config :ueberauth, Ueberauth,
  providers: [
    gitlab: { Ueberauth.Strategy.Gitlab, [] }
  ]

Then include the configuration for gitlab.

config :ueberauth, Ueberauth.Strategy.Gitlab.OAuth,
  client_id: System.get_env("GITLAB_CLIENT_ID"),
  client_secret: System.get_env("GITLAB_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 uid_field

config :ueberauth, Ueberauth,
  providers: [
    gitlab: { Ueberauth.Strategy.Gitlab, [uid_field: :email] }
  ]

Default is :id

To set the default 'scopes' (permissions):

config :ueberauth, Ueberauth,
  providers: [
    gitlab: { Ueberauth.Strategy.Gitlab, [default_scope: "api read_user read_registry", api_version: "v4"] }
  ]

Default is "api read_user read_registry"

Link to this section Summary

Functions

auth(conn)

credentials(conn)

Includes the credentials from the Gitlab response.

default_options()

extra(conn)

Stores the raw information (including the token) obtained from the Gitlab callback.

handle_cleanup!(conn)

Cleans up the private area of the connection used for passing the raw Gitlab response around during the callback.

handle_request!(conn)

Handles the initial redirect to the gitlab authentication page.

info(conn)

Fetches the fields to populate the info section of the Ueberauth.Auth struct.

uid(conn)

Fetches the uid field from the Gitlab response. This defaults to the option uid_field which in-turn defaults to id

Link to this section Functions