strapi-identity 0.4.2 → 0.5.1

package/dist/server/src/content-types/config/schema.json.d.ts

@@ -0,0 +1,72 @@
+declare const _default: {
+  "kind": "singleType",
+  "collectionName": "strapi-identity-config",
+  "info": {
+    "singularName": "strapi-identity-config",
+    "pluralName": "strapi-identity-configs",
+    "displayName": "Strapi Identity Config"
+  },
+  "options": {
+    "draftAndPublish": false
+  },
+  "pluginOptions": {
+    "content-manager": {
+      "visible": false
+    },
+    "content-type-builder": {
+      "visible": false
+    }
+  },
+  "attributes": {
+    "enabled": {
+      "type": "boolean",
+      "default": false
+    },
+    "enforce": {
+      "type": "boolean",
+      "default": false
+    },
+    "issuer": {
+      "type": "string",
+      "required": false,
+      "default": "Strapi"
+    },
+    "email_enabled": {
+      "type": "boolean",
+      "default": false
+    },
+    "from_email": {
+      "type": "string",
+      "required": false,
+      "default": ""
+    },
+    "from_name": {
+      "type": "string",
+      "required": false,
+      "default": ""
+    },
+    "response_email": {
+      "type": "string",
+      "required": false,
+      "default": ""
+    },
+    "subject": {
+      "type": "string",
+      "required": false,
+      "default": ""
+    },
+    "text": {
+      "type": "text",
+      "required": false,
+      "default": ""
+    },
+    "message": {
+      "type": "text",
+      "required": false,
+      "default": ""
+    }
+  }
+}
+;
+
+export default _default;

package/dist/server/src/content-types/email-otp/index.d.ts

@@ -0,0 +1,48 @@
+declare const _default: {
+    schema: {
+        kind: string;
+        collectionName: string;
+        info: {
+            singularName: string;
+            pluralName: string;
+            displayName: string;
+        };
+        options: {
+            draftAndPublish: boolean;
+        };
+        pluginOptions: {
+            "content-manager": {
+                visible: boolean;
+            };
+            "content-type-builder": {
+                visible: boolean;
+            };
+        };
+        attributes: {
+            admin_user: {
+                type: string;
+                relation: string;
+                target: string;
+            };
+            code_hash: {
+                type: string;
+                required: boolean;
+                private: boolean;
+            };
+            expires_at: {
+                type: string;
+                required: boolean;
+            };
+            attempts: {
+                type: string;
+                default: number;
+            };
+            purpose: {
+                type: string;
+                enum: string[];
+                default: string;
+            };
+        };
+    };
+};
+export default _default;

package/dist/server/src/content-types/email-otp/schema.json.d.ts

@@ -0,0 +1,48 @@
+declare const _default: {
+  "kind": "collectionType",
+  "collectionName": "email-otps",
+  "info": {
+    "singularName": "email-otp",
+    "pluralName": "email-otps",
+    "displayName": "Email OTP"
+  },
+  "options": {
+    "draftAndPublish": false
+  },
+  "pluginOptions": {
+    "content-manager": {
+      "visible": false
+    },
+    "content-type-builder": {
+      "visible": false
+    }
+  },
+  "attributes": {
+    "admin_user": {
+      "type": "relation",
+      "relation": "oneToOne",
+      "target": "admin::user"
+    },
+    "code_hash": {
+      "type": "string",
+      "required": true,
+      "private": true
+    },
+    "expires_at": {
+      "type": "string",
+      "required": true
+    },
+    "attempts": {
+      "type": "integer",
+      "default": 0
+    },
+    "purpose": {
+      "type": "enumeration",
+      "enum": ["login", "setup", "disable"],
+      "default": "login"
+    }
+  }
+}
+;
+
+export default _default;

package/dist/server/src/content-types/index.d.ts

@@ -0,0 +1,3 @@
+import { Plugin } from '@strapi/types';
+declare const contentTypes: Plugin.LoadedPlugin['contentTypes'];
+export default contentTypes;

package/dist/server/src/content-types/mfa/index.d.ts

@@ -0,0 +1,55 @@
+declare const _default: {
+    schema: {
+        kind: string;
+        collectionName: string;
+        info: {
+            singularName: string;
+            pluralName: string;
+            displayName: string;
+        };
+        options: {
+            draftAndPublish: boolean;
+        };
+        pluginOptions: {
+            "content-manager": {
+                visible: boolean;
+            };
+            "content-type-builder": {
+                visible: boolean;
+            };
+        };
+        attributes: {
+            admin_user: {
+                type: string;
+                relation: string;
+                target: string;
+            };
+            enabled: {
+                type: string;
+                default: boolean;
+            };
+            type: {
+                type: string;
+                enum: string[];
+                default: string;
+            };
+            secret: {
+                type: string;
+                private: boolean;
+            };
+            counter: {
+                type: string;
+                default: string;
+            };
+            digits: {
+                type: string;
+                default: number;
+            };
+            recovery_codes: {
+                type: string;
+                private: boolean;
+            };
+        };
+    };
+};
+export default _default;

package/dist/server/src/content-types/mfa/schema.json.d.ts

@@ -0,0 +1,55 @@
+declare const _default: {
+  "kind": "collectionType",
+  "collectionName": "mfa-tokens",
+  "info": {
+    "singularName": "mfa-token",
+    "pluralName": "mfa-tokens",
+    "displayName": "MFA Token"
+  },
+  "options": {
+    "draftAndPublish": false
+  },
+  "pluginOptions": {
+    "content-manager": {
+      "visible": false
+    },
+    "content-type-builder": {
+      "visible": false
+    }
+  },
+  "attributes": {
+    "admin_user": {
+      "type": "relation",
+      "relation": "oneToOne",
+      "target": "admin::user"
+    },
+    "enabled": {
+      "type": "boolean",
+      "default": false
+    },
+    "type": {
+      "type": "enumeration",
+      "enum": ["totp", "hotp", "email"],
+      "default": "totp"
+    },
+    "secret": {
+      "type": "string",
+      "private": true
+    },
+    "counter": {
+      "type": "biginteger",
+      "default": "0"
+    },
+    "digits": {
+      "type": "integer",
+      "default": 6
+    },
+    "recovery_codes": {
+      "type": "json",
+      "private": true
+    }
+  }
+}
+;
+
+export default _default;

package/dist/server/src/content-types/temp-mfa/index.d.ts

@@ -0,0 +1,35 @@
+declare const _default: {
+    schema: {
+        kind: string;
+        collectionName: string;
+        info: {
+            singularName: string;
+            pluralName: string;
+            displayName: string;
+        };
+        options: {
+            draftAndPublish: boolean;
+        };
+        pluginOptions: {
+            "content-manager": {
+                visible: boolean;
+            };
+            "content-type-builder": {
+                visible: boolean;
+            };
+        };
+        attributes: {
+            admin_user: {
+                type: string;
+                relation: string;
+                target: string;
+            };
+            secret: {
+                type: string;
+                required: boolean;
+                private: boolean;
+            };
+        };
+    };
+};
+export default _default;

package/dist/server/src/content-types/temp-mfa/schema.json.d.ts

@@ -0,0 +1,35 @@
+declare const _default: {
+  "kind": "collectionType",
+  "collectionName": "mfa-temps",
+  "info": {
+    "singularName": "mfa-temp",
+    "pluralName": "mfa-temps",
+    "displayName": "MFA Temp"
+  },
+  "options": {
+    "draftAndPublish": false
+  },
+  "pluginOptions": {
+    "content-manager": {
+      "visible": false
+    },
+    "content-type-builder": {
+      "visible": false
+    }
+  },
+  "attributes": {
+    "admin_user": {
+      "type": "relation",
+      "relation": "oneToOne",
+      "target": "admin::user"
+    },
+    "secret": {
+      "type": "string",
+      "required": false,
+      "private": true
+    }
+  }
+}
+;
+
+export default _default;

package/dist/server/src/controllers/admin.d.ts

@@ -0,0 +1,4 @@
+import { Plugin } from '@strapi/types';
+type controller = Plugin.LoadedPlugin['controllers'][string];
+declare const _default: controller;
+export default _default;

package/dist/server/src/controllers/config.d.ts

@@ -0,0 +1,4 @@
+import { Plugin } from '@strapi/types';
+type controller = Plugin.LoadedPlugin['controllers'][string];
+declare const _default: controller;
+export default _default;

package/dist/server/src/controllers/controller.d.ts

@@ -0,0 +1,8 @@
+import { Core } from '@strapi/strapi';
+import { Plugin } from '@strapi/types';
+type controller = Plugin.LoadedPlugin['controllers'][string];
+declare const controller: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => controller;
+declare const _default: controller;
+export default _default;

package/dist/server/src/controllers/index.d.ts

@@ -0,0 +1,3 @@
+import { Plugin } from '@strapi/strapi';
+declare const controllers: Plugin.LoadedPlugin['controllers'];
+export default controllers;

package/dist/server/src/destroy.d.ts

@@ -0,0 +1,3 @@
+import { Plugin } from '@strapi/types';
+declare const destroy: Plugin.LoadedPlugin['destroy'];
+export default destroy;

package/dist/server/src/middlewares/index.d.ts

@@ -0,0 +1,3 @@
+import { Plugin } from '@strapi/types';
+declare const middlewares: Plugin.LoadedPlugin['middlewares'];
+export default middlewares;

package/dist/server/src/policies/has-mfa.d.ts

@@ -0,0 +1,3 @@
+import { Plugin } from '@strapi/types';
+declare const policy: Plugin.LoadedPlugin['policies'][string];
+export default policy;

package/dist/server/src/policies/index.d.ts

@@ -0,0 +1,3 @@
+import { Plugin } from '@strapi/types';
+declare const policies: Plugin.LoadedPlugin['policies'];
+export default policies;

package/dist/server/src/register.d.ts

@@ -0,0 +1,3 @@
+import { Plugin } from '@strapi/types';
+declare const register: Plugin.LoadedPlugin['register'];
+export default register;

package/dist/server/src/routes/admin/admin.json.d.ts

@@ -0,0 +1,35 @@
+declare const _default: [
+  {
+    "method": "GET",
+    "path": "/admin/user/:id",
+    "handler": "admin.isEnabled",
+    "info": { "apiName": "isEnabled", "pluginName": "strapi-identity", "type": "content-api" },
+    "config": {
+      "policies": [
+        "admin::isAuthenticatedAdmin",
+        {
+          "name": "admin::hasPermissions",
+          "config": { "actions": ["plugin::strapi-identity.settings.read"] }
+        }
+      ]
+    }
+  },
+  {
+    "method": "DELETE",
+    "path": "/admin/user/:id",
+    "handler": "admin.reset",
+    "info": { "apiName": "reset", "pluginName": "strapi-identity", "type": "content-api" },
+    "config": {
+      "policies": [
+        "admin::isAuthenticatedAdmin",
+        {
+          "name": "admin::hasPermissions",
+          "config": { "actions": ["plugin::strapi-identity.settings.update"] }
+        }
+      ]
+    }
+  }
+]
+;
+
+export default _default;

package/dist/server/src/routes/admin/config.json.d.ts

@@ -0,0 +1,50 @@
+declare const _default: [
+  {
+    "method": "GET",
+    "path": "/config/enabled",
+    "handler": "config.isEnabled",
+    "info": { "apiName": "isEnabled", "pluginName": "strapi-identity", "type": "content-api" },
+    "config": {
+      "policies": [
+        "admin::isAuthenticatedAdmin",
+        {
+          "name": "admin::hasPermissions",
+          "config": { "actions": ["plugin::strapi-identity.settings.read"] }
+        }
+      ]
+    }
+  },
+  {
+    "method": "GET",
+    "path": "/config",
+    "handler": "config.getConfig",
+    "info": { "apiName": "getConfig", "pluginName": "strapi-identity", "type": "content-api" },
+    "config": {
+      "policies": [
+        "admin::isAuthenticatedAdmin",
+        {
+          "name": "admin::hasPermissions",
+          "config": { "actions": ["plugin::strapi-identity.settings.read"] }
+        }
+      ]
+    }
+  },
+  {
+    "method": "PUT",
+    "path": "/config",
+    "handler": "config.updateConfig",
+    "info": { "apiName": "updateConfig", "pluginName": "strapi-identity", "type": "content-api" },
+    "config": {
+      "policies": [
+        "admin::isAuthenticatedAdmin",
+        {
+          "name": "admin::hasPermissions",
+          "config": { "actions": ["plugin::strapi-identity.settings.update"] }
+        }
+      ]
+    }
+  }
+]
+;
+
+export default _default;

package/dist/server/src/routes/admin/index.d.ts

@@ -0,0 +1,3 @@
+import { Plugin } from '@strapi/types';
+declare const _default: Plugin.LoadedPlugin["routes"]["admin"];
+export default _default;

package/dist/server/src/routes/admin/mfa.json.d.ts

@@ -0,0 +1,94 @@
+declare const _default: [
+  {
+    "method": "GET",
+    "path": "/verify/info",
+    "handler": "controller.verifyInfo",
+    "info": { "apiName": "verifyInfo", "pluginName": "strapi-identity", "type": "content-api" },
+    "config": {
+      "auth": false,
+      "policies": ["has-mfa"]
+    }
+  },
+  {
+    "method": "POST",
+    "path": "/verify",
+    "handler": "controller.verify",
+    "info": { "apiName": "verify", "pluginName": "strapi-identity", "type": "content-api" },
+    "config": {
+      "auth": false,
+      "policies": ["has-mfa"],
+      "middlewares": ["admin::rateLimit"]
+    }
+  },
+  {
+    "method": "POST",
+    "path": "/enable",
+    "handler": "controller.enable",
+    "info": { "apiName": "enable", "pluginName": "strapi-identity", "type": "content-api" },
+    "config": {}
+  },
+  {
+    "method": "POST",
+    "path": "/setup",
+    "handler": "controller.setup",
+    "info": { "apiName": "setup", "pluginName": "strapi-identity", "type": "content-api" },
+    "config": {}
+  },
+  {
+    "method": "POST",
+    "path": "/disable",
+    "handler": "controller.disable",
+    "info": { "apiName": "disable", "pluginName": "strapi-identity", "type": "content-api" },
+    "config": {}
+  },
+  {
+    "method": "GET",
+    "path": "/status",
+    "handler": "controller.checkStatus",
+    "info": { "apiName": "checkStatus", "pluginName": "strapi-identity", "type": "content-api" },
+    "config": {}
+  },
+  {
+    "method": "POST",
+    "path": "/verify/resend",
+    "handler": "controller.resendVerifyOTP",
+    "info": {
+      "apiName": "resendVerifyOTP",
+      "pluginName": "strapi-identity",
+      "type": "content-api"
+    },
+    "config": {
+      "auth": false,
+      "policies": ["has-mfa"],
+      "middlewares": ["admin::rateLimit"]
+    }
+  },
+  {
+    "method": "POST",
+    "path": "/enable-email",
+    "handler": "controller.enableEmail",
+    "info": { "apiName": "enableEmail", "pluginName": "strapi-identity", "type": "content-api" },
+    "config": {}
+  },
+  {
+    "method": "POST",
+    "path": "/setup-email",
+    "handler": "controller.setupEmail",
+    "info": { "apiName": "setupEmail", "pluginName": "strapi-identity", "type": "content-api" },
+    "config": {}
+  },
+  {
+    "method": "POST",
+    "path": "/disable-email/request",
+    "handler": "controller.requestDisableEmailOTP",
+    "info": {
+      "apiName": "requestDisableEmailOTP",
+      "pluginName": "strapi-identity",
+      "type": "content-api"
+    },
+    "config": {}
+  }
+]
+;
+
+export default _default;

package/dist/server/src/routes/index.d.ts

@@ -0,0 +1,3 @@
+import { Plugin } from '@strapi/types';
+declare const routes: Plugin.LoadedPlugin['routes'];
+export default routes;

package/dist/server/src/services/admin.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Check if 2FA is enabled for a user by looking for an associated MFA token.
+ * @param id the user's ID to check for an associated MFA token, indicating that 2FA is enabled for that user
+ * @returns a boolean indicating whether 2FA is enabled for the user (true if an MFA token exists, false otherwise)
+ */
+export declare const isEnabled: (id: string) => false | Promise<boolean>;
+/**
+ * Resets 2FA for a user by deleting any existing MFA token and temporary secret associated with that user.
+ * @param id the user's ID for which to reset 2FA, which will delete any associated MFA token and temporary secret, effectively disabling 2FA for that user until they set it up again
+ */
+export declare const reset: (id: string) => Promise<void>;

package/dist/server/src/services/config.d.ts

@@ -0,0 +1,57 @@
+declare const defaultConfig: {
+    email_enabled: boolean;
+    enabled: boolean;
+    enforce: boolean;
+    from_email: string;
+    from_name: string;
+    issuer: string;
+    message: string;
+    response_email: string;
+    subject: string;
+    text: string;
+};
+/**
+ * Service for managing the Strapi Identity plugin configuration
+ * @returns an object containing functions to get and update the plugin configuration
+ */
+export declare const isEnabled: () => Promise<boolean>;
+/**
+ * Retrieves the current configuration for the Strapi Identity plugin
+ * @returns the current configuration
+ */
+export declare const getConfig: () => Promise<{
+    email_enabled: boolean;
+    enabled: boolean;
+    enforce: boolean;
+    from_email: string;
+    from_name: string;
+    issuer: string;
+    message: string;
+    response_email: string;
+    subject: string;
+    text: string;
+}>;
+/**
+ * Updates the Strapi Identity plugin configuration with the provided data
+ * @param data partial configuration data to update
+ * @returns  the updated configuration
+ */
+export declare const updateConfig: (data: Partial<typeof defaultConfig>) => Promise<{
+    email_enabled: boolean;
+    enabled: boolean;
+    enforce: boolean;
+    from_email: string;
+    from_name: string;
+    issuer: string;
+    message: string;
+    response_email: string;
+    subject: string;
+    text: string;
+}>;
+/**
+ * Checks if a user has MFA enabled by verifying the provided JWT token and checking for an associated MFA token in the database
+ * @param jwtToken the JWT token to verify and extract the user ID from
+ * @returns true if the user has MFA enabled, false otherwise
+ */
+export declare const checkUserByJWT: (jwtToken: string) => Promise<boolean>;
+export {};

package/dist/server/src/services/email.d.ts

@@ -0,0 +1,8 @@
+export declare const send: (to: string, otp: string) => Promise<any>;
+/**
+ * Replaces template variables in a string with their corresponding values.
+ * @param template The template string containing variables in the format <%= VARIABLE %>.
+ * @param variables An object containing the variable values to replace in the template.
+ * @returns The template string with variables replaced by their corresponding values.
+ */
+export declare const replaceTemplateVariables: <T extends Record<string, string>>(template: string, variables: T) => string;