feat: simplified API routes

Removed the /oidc prefix whose only purpose was to differentiate between
providers we don't support anymore

Author: aartoni

README.md

@@ -51,7 +51,7 @@ module.exports = ({env}) => ({
       REMEMBER_ME: false,
 
       // OpenID Connect
-      OIDC_REDIRECT_URI: 'http://localhost:1337/strapi-plugin-sso/oidc/callback', // URI after successful login
+      OIDC_REDIRECT_URI: 'http://localhost:1337/api/strapi-plugin-sso/callback', // URI after successful login
       OIDC_CLIENT_ID: '[Client ID from OpenID Provider]',
       OIDC_CLIENT_SECRET: '[Client Secret from OpenID Provider]',
 

compose.yml

@@ -6,7 +6,7 @@ services:
       - OIDC_AUTHORIZATION_ENDPOINT=https://${AUTH_DOMAIN}/api/oidc/authorization
       - OIDC_TOKEN_ENDPOINT=https://${AUTH_DOMAIN}/api/oidc/token
       - OIDC_USER_INFO_ENDPOINT=https://${AUTH_DOMAIN}/api/oidc/userinfo
-      - OIDC_REDIRECT_URI=https://${CMS_DOMAIN}/api/strapi-plugin-sso/oidc/callback
+      - OIDC_REDIRECT_URI=https://${CMS_DOMAIN}/api/strapi-plugin-sso/callback
       # TODO Should we load the client ID + secret from secrets instead?
       - OIDC_CLIENT_ID=onbU2exrz2I0RCJRrXsCQj49dgLFHLppCekGGdKmBaQ_7MWpAKcnylw6kO-7lUhsUtzmGJM8
       - OIDC_CLIENT_SECRET=yebsr4POK_hXenANvvo4DAHBGPIP_3a0

config/authelia/configuration.yml

@@ -13,7 +13,7 @@ identity_providers:
         client_name: 'Strapi'
         client_secret: '{{ secret "/run/secrets/oidc_strapi_digest" }}'
         redirect_uris:
-          - https://{{ mustEnv "CMS_DOMAIN" }}/api/strapi-plugin-sso/oidc/callback
+          - https://{{ mustEnv "CMS_DOMAIN" }}/api/strapi-plugin-sso/callback
         scopes:
           - 'email'
           - 'groups'

cypress/e2e/login.cy.js

@@ -84,7 +84,7 @@ describe("SSO plugin", () => {
 
   describe("error rendering", () => {
     it("shows the error page when callback is missing the auth code", () => {
-      cy.visit(`${CMS}/api/${PLUGIN_ID}/oidc/callback`, {
+      cy.visit(`${CMS}/api/${PLUGIN_ID}/callback`, {
         failOnStatusCode: false,
       });
       cy.contains("Authentication failed").should("be.visible");

cypress/support/commands.js

@@ -19,7 +19,7 @@ Cypress.Commands.add("loginAs", (username, password) => {
         AUTHELIA_STACK.idp,
         { args: { cms: AUTHELIA_STACK.cms, username, password } },
         ({ cms, username, password }) => {
-          cy.visit(`${cms}/api/strapi-plugin-sso/oidc`);
+          cy.visit(`${cms}/api/strapi-plugin-sso/sign-in`);
           cy.get("#username-textfield").type(username);
           cy.get("#password-textfield").type(password);
           cy.get("#sign-in-button").click();

docs/en/oidc/setup.md

@@ -12,7 +12,7 @@ Depending on your OIDC Provider the setup may vary.
 
 | Key                                      | required | default                                               |
 | ---------------------------------------- | -------- | ----------------------------------------------------- |
-| OIDC_REDIRECT_URI                        | -        | http://localhost:1337/strapi-plugin-sso/oidc/callback |
+| OIDC_REDIRECT_URI                        | -        | http://localhost:1337/api/strapi-plugin-sso/callback |
 | OIDC_CLIENT_ID                           | ✅       | -                                                     |
 | OIDC_CLIENT_SECRET                       | ✅       | -                                                     |
 | OIDC_SCOPES                              | -        | openid profile email                                  |
@@ -32,7 +32,7 @@ module.exports = ({ env }) => ({
     config: {
       // OpenID Connect
       OIDC_REDIRECT_URI:
-        "http://localhost:1337/strapi-plugin-sso/oidc/callback", // URI after successful login
+        "http://localhost:1337/api/strapi-plugin-sso/callback", // URI after successful login
       OIDC_CLIENT_ID: "[Client ID from OpenID Provider]",
       OIDC_CLIENT_SECRET: "[Client Secret from OpenID Provider]",
 
@@ -53,7 +53,7 @@ module.exports = ({ env }) => ({
 ## 3. Sign in with your OIDC account
 
 ```
-http://localhost:1337/strapi-plugin-sso/oidc
+http://localhost:1337/api/strapi-plugin-sso
 ```
 
 If you can see the authentication screen of your OIDC Provider and then log in to the administration screen, you are done!

playground/.env

@@ -9,5 +9,5 @@ OIDC_TOKEN_ENDPOINT=https://auth.example.com/token
 OIDC_USER_INFO_ENDPOINT=https://auth.example.com/userinfo
 OIDC_CLIENT_ID=test-client-id
 OIDC_CLIENT_SECRET=test-secret
-OIDC_REDIRECT_URI=http://localhost:1337/oidc/callback
+OIDC_REDIRECT_URI=http://localhost:1337/api/strapi-plugin-sso/callback
 OIDC_SCOPES=openid profile email

server/src/config/index.ts

@@ -4,7 +4,7 @@ export default {
   default: {
     REMEMBER_ME: false,
 
-    OIDC_REDIRECT_URI: "http://localhost:1337/strapi-plugin-sso/oidc/callback",
+    OIDC_REDIRECT_URI: "http://localhost:1337/api/strapi-plugin-sso/callback",
     OIDC_CLIENT_ID: "",
     OIDC_CLIENT_SECRET: "",
     OIDC_SCOPES: "openid profile email",

server/src/routes/index.ts

@@ -16,15 +16,15 @@ export default {
       },
       {
         method: "GET",
-        path: "/oidc",
+        path: "/sign-in",
         handler: "oidc.oidcSignIn",
         config: {
           auth: false,
         },
       },
       {
         method: "GET",
-        path: "/oidc/callback",
+        path: "/callback",
         handler: "oidc.oidcSignInCallback",
         config: {
           auth: false,

server/src/tests/oidc.test.js

@@ -21,7 +21,7 @@ afterAll(async () => {
 describe("OIDC sign in", () => {
   it("should redirect with 302 and set session values", async () => {
     const res = await request(strapi.server.httpServer).get(
-      "/api/strapi-plugin-sso/oidc",
+      "/api/strapi-plugin-sso/sign-in",
     );
 
     expect(res.status).toBe(302);
@@ -45,7 +45,7 @@ describe("OIDC sign in", () => {
 
     // Start the authentication flow (keeps the session cookie)
     const authStart = await agent
-      .get("/api/strapi-plugin-sso/oidc")
+      .get("/api/strapi-plugin-sso/sign-in")
       .expect(302);
     const redirectUrl = new URL(authStart.headers.location);
     const state = redirectUrl.searchParams.get("state");
@@ -66,7 +66,7 @@ describe("OIDC sign in", () => {
 
     // Hit the callback
     const res = await agent.get(
-      `/api/strapi-plugin-sso/oidc/callback?code=FAKE_CODE&state=${state}`,
+      `/api/strapi-plugin-sso/callback?code=FAKE_CODE&state=${state}`,
     );
 
     // Sanity checks