refactor: use master branch of OpenIDConnect

DefactoSoftware · Nov 3, 2023 · e1e9c09 · e1e9c09
1 parent 0e46efb
commit e1e9c09
Show file tree

Hide file tree

Showing 11 changed files with 521 additions and 681 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,82 @@
+name: CI
+
+on: 
+  push:
+  pull_request: 
+
+jobs:
+  asdf:
+    name: ASDF
+    runs-on: ubuntu-22.04
+
+    steps:
+      - uses: actions/checkout@v4
+      # cache the ASDF directory, using the values from .tool-versions
+      - name: ASDF cache
+        uses: actions/cache@v3
+        with:
+          path: ~/.asdf
+          key: ${{ runner.os }}-asdf-v2-${{ hashFiles('.tool-versions') }}
+        id: asdf-cache
+      # only run `asdf install` if we didn't hit the cache
+      - uses: asdf-vm/actions/install@v2
+        if: steps.asdf-cache.outputs.cache-hit != 'true'
+
+  build:
+    name: Build Elixir
+    runs-on: ubuntu-22.04
+    needs: asdf
+    steps:
+      - uses: actions/checkout@v4
+      - name: ASDF cache
+        uses: actions/cache@v3
+        with:
+          path: ~/.asdf
+          key: ${{ runner.os }}-asdf-v2-${{ hashFiles('.tool-versions') }}
+        id: asdf-cache
+      - uses: mbta/actions/reshim-asdf@v1
+      - name: Restore dependencies cache
+        id: deps-cache
+        uses: actions/cache@v3
+        with:
+          path: deps
+          key: ${{ runner.os }}-mix-${{ hashFiles('**/mix.lock') }}
+          restore-keys: ${{ runner.os }}-mix-
+      - name: Install dependencies
+        run: |
+          mix local.rebar --force
+          mix local.hex --force
+          mix deps.get
+
+  elixir:
+    name: Test Elixir
+    runs-on: ubuntu-22.04
+    needs: build
+    steps:
+      - uses: actions/checkout@v4
+      - name: ASDF cache
+        uses: actions/cache@v3
+        with:
+          path: ~/.asdf
+          key: ${{ runner.os }}-asdf-v2-${{ hashFiles('.tool-versions') }}
+        id: asdf-cache
+      - uses: mbta/actions/reshim-asdf@v1
+      - name: Restore dependencies cache
+        id: deps-cache
+        uses: actions/cache@v3
+        with:
+          path: deps
+          key: ${{ runner.os }}-mix-${{ hashFiles('**/mix.lock') }}
+          restore-keys: ${{ runner.os }}-mix-
+      - name: Install dependencies
+        run: |
+          mix local.rebar --force
+          mix local.hex --force
+      - name: Compile (warnings as errors)
+        run: mix compile --force --warnings-as-errors
+      - name: Check formatting
+        run: mix format --check-formatted
+      - name: Run tests
+        run: mix test --cover
+      - name: Run Credo
+        run: mix credo --strict
diff --git a/.tool-versions b/.tool-versions
@@ -0,0 +1,2 @@
+elixir 1.13.4-otp-24
+erlang 24.3.4.14
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 rng2
+Copyright (c) 2018 rng2, 2023 Massachusetts Bay Transportation Authority
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -6,15 +6,16 @@ This library provides an OIDC strategy for Ueberauth using the information in th
 Only supports `authorization_code` flow for now.
 Has optional support for `/userinfo` endpoints, and has the option to get a user's `uid_field` from either the claims or the userinfo.
 
-*Originally based on rng2/ueberauth_oidc but has now diverged significantly from the source*
+*Originally based on Defactosoftware/ueberauth_oidc and rng2/ueberauth_oidc but
+has now diverged significantly from the source*
 
 ## Installation
 
 1. Add `:ueberauth_oidc` to your list of dependencies in `mix.exs`:
 
     ```elixir
     def deps do
-      [{:ueberauth_oidc, git: "https://github.com/DefactoSoftware/ueberauth_oidc.git"}]
+      [{:ueberauth_oidc, github: "mbta/ueberauth_oidc"}]
     end
     ```
 
@@ -28,48 +29,30 @@ Has optional support for `/userinfo` endpoints, and has the option to get a user
 
 ## Configuration
 
-1. Add OIDC to your Ueberauth configuration:
+1. Add OIDC to your Ueberauth configuration.
+See [OpenIDConnect](https://github.com/DockYard/openid_connect/blob/master/README.md) and [Ueberauth](https://hexdocs.pm/ueberauth/readme.html#configuring-providers)
+for a list of supported options.
 
     ```elixir
     config :ueberauth, Ueberauth,
       providers: [
-        oidc: { Ueberauth.Strategy.OIDC, [
-          default: [
-            # required, set to default provider you want to use
-            provider: :default_oidc,
-
-            # optional
-            uid_field: :sub
-          ],
-
-          # optional override for each provider
-          google: [uid_field: :email],
-          ...
-        ] }
+        oidc: { Ueberauth.Strategy.OIDC,
+          discovery_document_uri: "https://oidc.example/.well-known/openid-configuration",
+          client_id: "client_id",
+          client_secret: "123456789",
+          response_type: "code",
+          scope: "openid profile email",
+          # optional
+          callback_path: "/auth/oidc/callback",
+          fetch_userinfo: true, # true/false
+          userinfo_uid_field: "upn", # only include if getting the user_id from userinfo
+          uid_field: "sub" # only include if getting the user_id from the claims,
+          request_params: %{} # additional parameters for the initial request
+          request_uri: "https://oidc-override/request" # override the initial request URI
+        }
       ]
     ```
 
-1. Update your provider configuration.
-See [OpenIDConnect](https://hexdocs.pm/openid_connect/readme.html)
-for a list of supported options.
-
-    ```elixir
-    config :ueberauth, Ueberauth.Strategy.OIDC,
-      # one or more providers
-      default_oidc: [
-        fetch_userinfo: true, # true/false
-        userinfo_uid_field: "upn", # only include if getting the user_id from userinfo
-        uid_field: "sub" # only include if getting the user_id from the claims
-        discovery_document_uri: "https://oidc.example/.well-known/openid-configuration",
-        client_id: "client_id",
-        client_secret: "123456789",
-        redirect_uri: "https://your.url/auth/oidc/callback",
-        response_type: "code",
-        scope: "openid profile email"
-      ],
-      ...
-    ```
-
 ## Usage
 
 1. Include the Ueberauth plug in your controller:
@@ -96,44 +79,24 @@ for a list of supported options.
 1. Your controller needs to implement callbacks to deal with `Ueberauth.Auth`
 and `Ueberauth.Failure` responses. For an example implementation see the
 [Ueberauth Example](https://github.com/ueberauth/ueberauth_example) application.
-Note that the `Ueberauth.Strategy.Info` struct stored in `Ueberauth.Auth`
-will be empty. Use the information in `Ueberauth.Auth.Credentials` and
-`Ueberauth.Strategy.Extra` instead:
 
    - `Ueberauth.Auth.Credentials` contains the `access_token` and related fields
 
-   - The `other` map in `Ueberauth.Auth.Credentials` contains `provider` and `user_info`
-
-   - `Ueberauth.Strategy.Extra` contains the raw claims, tokens and opts
+   - The `other` map in `Ueberauth.Auth.Credentials` contains `id_token`
 
-1.  Add `OpenIDConnect.Worker` with a provider list during application startup:
-
-	  ```elixir
-    def start(_type, _args) do
-      ...
-      children = [
-        ...,
-        {OpenIDConnect.Worker, Application.get_env(:ueberauth, Ueberauth.Strategy.OIDC)},
-        ...
-      ]
-      ...
-      Supervisor.start_link(children, opts)
-    end
-    ```
+   - `Ueberauth.Strategy.Extra` contains the raw claims, userinfo, and tokens 
 
 ## Calling
 
 Depending on the configured url, you can initialize the request through:
 
     /auth/oidc
 
-To use another provider instead of the configured default, add the `oidc_provider` option:
-
-    /auth/oidc?oidc_provider=google
-
 ## License
 
 Please see [LICENSE](https://github.com/DefactoSoftware/ueberauth_oidc/blob/master/LICENSE)
 for licensing details.
 
-Loosely based on [rng2/ueberauth_oidc](https://github.com/rng2/ueberauth_oidc).
+Based on:
+- [Defactosoftware/ueberauth_oidc](https://github.com/Defactosoftware/ueberauth_oidc)
+- [rng2/ueberauth_oidc](https://github.com/rng2/ueberauth_oidc)
diff --git a/config/config.exs b/config/config.exs
@@ -1,30 +1 @@
-# This file is responsible for configuring your application
-# and its dependencies with the aid of the Mix.Config module.
-use Mix.Config
-
-# This configuration is loaded before any dependency and is restricted
-# to this project. If another project depends on this project, this
-# file won't be loaded nor affect the parent project. For this reason,
-# if you want to provide default values for your application for
-# 3rd-party users, it should be done in your "mix.exs" file.
-
-# You can configure your application as:
-#
-#     config :ueberauth_oidc, key: :value
-#
-# and access this configuration in your application as:
-#
-#     Application.get_env(:ueberauth_oidc, :key)
-#
-# You can also configure a 3rd-party app:
-#
-#     config :logger, level: :info
-#
-
-# It is also possible to import configuration files, relative to this
-# directory. For example, you can emulate configuration per environment
-# by uncommenting the line below and defining dev.exs, test.exs and such.
-# Configuration from the imported file will override the ones defined
-# here (which is why it is important to import them last).
-#
-#     import_config "#{Mix.env}.exs"
+import Config