feat: add node ace add to solvro auth

Author: Rei-x

.keycloakify/realm-kc-26.json

@@ -1718,14 +1718,14 @@
         "subComponents": {},
         "config": {
           "allowed-protocol-mapper-types": [
-            "oidc-full-name-mapper",
-            "oidc-address-mapper",
             "saml-user-attribute-mapper",
-            "saml-user-property-mapper",
-            "saml-role-list-mapper",
             "oidc-sha256-pairwise-sub-mapper",
-            "oidc-usermodel-attribute-mapper",
-            "oidc-usermodel-property-mapper"
+            "oidc-address-mapper",
+            "saml-role-list-mapper",
+            "oidc-usermodel-property-mapper",
+            "oidc-full-name-mapper",
+            "saml-user-property-mapper",
+            "oidc-usermodel-attribute-mapper"
           ]
         }
       },
@@ -1755,14 +1755,14 @@
         "subComponents": {},
         "config": {
           "allowed-protocol-mapper-types": [
-            "saml-user-attribute-mapper",
-            "saml-user-property-mapper",
-            "oidc-sha256-pairwise-sub-mapper",
             "oidc-address-mapper",
-            "saml-role-list-mapper",
             "oidc-usermodel-property-mapper",
+            "oidc-full-name-mapper",
+            "saml-user-property-mapper",
             "oidc-usermodel-attribute-mapper",
-            "oidc-full-name-mapper"
+            "saml-user-attribute-mapper",
+            "saml-role-list-mapper",
+            "oidc-sha256-pairwise-sub-mapper"
           ]
         }
       },

examples/adonisjs/app/controllers/auth_controller.ts

@@ -0,0 +1,39 @@
+import assert from "node:assert";
+
+import type { HttpContext } from "@adonisjs/core/http";
+
+import User from "#models/user";
+
+export default class AuthController {
+  async login(ctx: HttpContext): Promise<void> {
+    const driver = ctx.ally.use("solvroAuth");
+
+    return driver.redirect();
+  }
+
+  async callback(ctx: HttpContext): Promise<void> {
+    const driver = ctx.ally.use("solvroAuth");
+
+    const details = await driver.user();
+
+    assert(details.email !== null, "Invalid user profile. Email is missing");
+
+    const user = await User.firstOrCreate(
+      { email: details.email },
+      {
+        email: details.email,
+        fullName: details.name,
+      },
+    );
+
+    await ctx.auth.use("web").login(user);
+
+    return ctx.response.redirect("/");
+  }
+
+  async logout(ctx: HttpContext): Promise<void> {
+    await ctx.auth.use("web").logout();
+
+    return ctx.response.redirect("/");
+  }
+}

examples/adonisjs/app/models/user.ts

@@ -1,16 +1,8 @@
 import { DateTime } from "luxon";
 
-import { withAuthFinder } from "@adonisjs/auth/mixins/lucid";
-import { compose } from "@adonisjs/core/helpers";
-import hash from "@adonisjs/core/services/hash";
 import { BaseModel, column } from "@adonisjs/lucid/orm";
 
-const AuthFinder = withAuthFinder(() => hash.use("scrypt"), {
-  uids: ["email"],
-  passwordColumnName: "password",
-});
-
-export default class User extends compose(BaseModel, AuthFinder) {
+export default class User extends BaseModel {
   @column({ isPrimary: true })
   declare id: number;
 

examples/adonisjs/config/ally.ts

@@ -2,16 +2,14 @@ import { defineConfig } from "@adonisjs/ally";
 
 import env from "#start/env";
 
-import { KeycloakDriverService } from "../../../packages/ally-solvro-auth/build/index.js";
+import { SolvroAuthDriverService } from "../../../packages/ally-solvro-auth/build/index.js";
 
 const allyConfig = defineConfig({
-  keycloak: KeycloakDriverService({
-    callbackUrl: "http://localhost:3333/auth/keycloak/callback",
-    clientId: env.get("KEYCLOAK_CLIENT_ID", "myclient"),
-    clientSecret: env.get("KEYCLOAK_CLIENT_SECRET", ""),
-    keycloakUrl:
-      "http://localhost:8080/realms/{realm}/protocol/openid-connect/{action}",
-    realm: env.get("KEYCLOAK_REALM", "myrealm"),
+  solvroAuth: SolvroAuthDriverService({
+    callbackUrl: `${env.get("APP_DOMAIN")}/auth/callback`,
+    clientId: env.get("SOLVRO_AUTH_CLIENT_ID", "myclient"),
+    clientSecret: env.get("SOLVRO_AUTH_CLIENT_SECRET", ""),
+    solvroAuthUrl: "http://localhost:8080",
   }),
 });
 

examples/adonisjs/database/migrations/1739284529117_create_users_table.ts

@@ -8,7 +8,6 @@ export default class extends BaseSchema {
       table.increments("id").notNullable();
       table.string("full_name").nullable();
       table.string("email", 254).notNullable().unique();
-      table.string("password").notNullable();
 
       table.timestamp("created_at").notNullable();
       table.timestamp("updated_at").nullable();

examples/adonisjs/start/env.ts

@@ -14,6 +14,7 @@ export default await Env.create(new URL("../", import.meta.url), {
   NODE_ENV: Env.schema.enum(["development", "production", "test"] as const),
   PORT: Env.schema.number(),
   APP_KEY: Env.schema.string(),
+  APP_DOMAIN: Env.schema.string(),
   HOST: Env.schema.string({ format: "host" }),
   LOG_LEVEL: Env.schema.enum([
     "fatal",
@@ -31,6 +32,6 @@ export default await Env.create(new URL("../", import.meta.url), {
   */
   SESSION_DRIVER: Env.schema.enum(["cookie", "memory"] as const),
 
-  KEYCLOAK_CLIENT_ID: Env.schema.string(),
-  KEYCLOAK_CLIENT_SECRET: Env.schema.string.optional(),
+  SOLVRO_AUTH_CLIENT_ID: Env.schema.string(),
+  SOLVRO_AUTH_CLIENT_SECRET: Env.schema.string.optional(),
 });

examples/adonisjs/start/kernel.ts

@@ -44,4 +44,5 @@ router.use([
 export const middleware = router.named({
   guest: () => import("#middleware/guest_middleware"),
   auth: () => import("#middleware/auth_middleware"),
+  silentAuth: () => import("#middleware/silent_auth_middleware"),
 });

examples/adonisjs/start/routes.ts

@@ -8,55 +8,21 @@
 */
 import router from "@adonisjs/core/services/router";
 
-import User from "#models/user";
-
-router.get("/auth/keycloak/redirect", ({ ally }) => {
-  return ally.use("keycloak").redirect();
-});
-
-router.get("/auth/keycloak/callback", async ({ ally, auth }) => {
-  const keycloak = ally.use("keycloak");
-  /**
-   * User has denied access by canceling
-   * the login flow
-   */
-  if (keycloak.accessDenied()) {
-    return "You have cancelled the login process";
-  }
-
-  /**
-   * OAuth state verification failed. This happens when the
-   * CSRF cookie gets expired.
-   */
-  if (keycloak.stateMisMatch()) {
-    return "We are unable to verify the request. Please try again";
-  }
-
-  /**
-   * GitHub responded with some error
-   */
-  if (keycloak.hasError()) {
-    return keycloak.getError();
-  }
-
-  /**
-   * Access user info
-   */
-  const keycloakUser = await keycloak.user();
-
-  const user = await User.firstOrCreate(
-    { email: keycloakUser.email },
-    {
-      email: keycloakUser.email,
-    },
-  );
-
-  auth.use("web").login();
-  return user;
-});
-
-router.get("/", async () => {
-  return {
-    hello: "world",
-  };
-});
+import { middleware } from "./kernel.js";
+
+const AuthController = () => import("#controllers/auth_controller");
+
+router.get("/auth/login", [AuthController, "login"]).use(middleware.guest());
+router
+  .get("/auth/callback", [AuthController, "callback"])
+  .use(middleware.guest());
+router.post("/auth/logout", [AuthController, "logout"]).use(middleware.auth());
+
+router
+  .get("/", async ({ auth }) => {
+    return {
+      hello: "world",
+      user: auth.user,
+    };
+  })
+  .use(middleware.silentAuth());

packages/ally-solvro-auth/configure.ts

@@ -0,0 +1,33 @@
+/**
+ * @rlanz/bull-queue
+ *
+ * @license MIT
+ * @copyright Romain Lanz <[email protected]>
+ */
+import type Configure from "@adonisjs/core/commands/configure";
+
+import { stubsRoot } from "./stubs/main.js";
+
+export async function configure(command: Configure) {
+  const codemods = await command.createCodemods();
+
+  await codemods.makeUsingStub(
+    stubsRoot,
+    "controllers/auth_controller.stub",
+    {},
+  );
+  // env variables: APP_DOMAIN, SOLVRO_AUTH_CLIENT_ID
+  // Add environment variables
+  await codemods.defineEnvVariables({
+    APP_DOMAIN: "http://localhost:3333",
+    SOLVRO_AUTH_CLIENT_ID: "MY_CLIENT_ID",
+  });
+
+  await codemods.defineEnvValidations({
+    variables: {
+      APP_DOMAIN: `Env.schema.string()`,
+      SOLVRO_AUTH_CLIENT_ID: "Env.schema.string()",
+    },
+    leadingComment: "Variables for @solvro/auth",
+  });
+}

packages/ally-solvro-auth/index.ts

@@ -1 +1,2 @@
 export * from "./src/driver.js";
+export { configure } from "./configure.js";