@formio/appserver 2.0.0-rc.8 → 2.0.0

package/lib/actions/index.d.ts

@@ -1,159 +1,6 @@
 declare const _default: {
-    save: {
-        readonly info: {
-            name: string;
-            title: string;
-            description: string;
-            priority: number;
-            defaults: {
-                handler: string[];
-                method: string[];
-            };
-            access: {
-                handler: boolean;
-                method: boolean;
-            };
-        };
-        mappingComponents(scope: import("@formio/appserver-types").ActionScope): Promise<any>;
-        settingsForm(scope: import("@formio/appserver-types").ActionScope): Promise<any>;
-        saveToForm(scope: import("@formio/appserver-types").ActionScope, resource: string): undefined;
-        childSubmission(scope: import("@formio/appserver-types").ActionScope, req: import("@formio/appserver-types").SubmissionRequest, res: import("@formio/appserver-types").SubmissionResponse, submission: any): any;
-        childResponse(scope: import("@formio/appserver-types").ActionScope, req: import("@formio/appserver-types").SubmissionRequest, res: import("@formio/appserver-types").SubmissionResponse): void;
-        executor(scope: import("@formio/appserver-types").ActionScope): Promise<(req: import("@formio/appserver-types").SubmissionRequest, res: import("@formio/appserver-types").SubmissionResponse, next: import("express").NextFunction) => Promise<void>>;
-    };
-    login: {
-        readonly info: {
-            name: string;
-            title: string;
-            description: string;
-            priority: number;
-            defaults: {
-                handler: string[];
-                method: string[];
-            };
-            access: {
-                handler: boolean;
-                method: boolean;
-            };
-        };
-        settingsForm(scope: import("@formio/appserver-types").ActionScope): Promise<({
-            type: string;
-            label: string;
-            key: string;
-            placeholder: string;
-            dataSrc: string;
-            valueProperty: string;
-            data: {
-                json: any;
-            };
-            multiple: boolean;
-            validate: {
-                required: boolean;
-            };
-            input?: undefined;
-            description?: undefined;
-            defaultValue?: undefined;
-            suffix?: undefined;
-        } | {
-            type: string;
-            input: boolean;
-            label: string;
-            key: string;
-            placeholder: string;
-            dataSrc: string;
-            valueProperty: string;
-            data: {
-                json: any;
-            };
-            multiple: boolean;
-            validate: {
-                required: boolean;
-            };
-            description?: undefined;
-            defaultValue?: undefined;
-            suffix?: undefined;
-        } | {
-            type: string;
-            key: string;
-            input: boolean;
-            label: string;
-            description: string;
-            defaultValue: string;
-            placeholder?: undefined;
-            dataSrc?: undefined;
-            valueProperty?: undefined;
-            data?: undefined;
-            multiple?: undefined;
-            validate?: undefined;
-            suffix?: undefined;
-        } | {
-            type: string;
-            key: string;
-            input: boolean;
-            label: string;
-            description: string;
-            defaultValue: string;
-            suffix: string;
-            placeholder?: undefined;
-            dataSrc?: undefined;
-            valueProperty?: undefined;
-            data?: undefined;
-            multiple?: undefined;
-            validate?: undefined;
-        })[]>;
-        waitText(time: number): string;
-        checkAttempts(scope: import("@formio/appserver-types").ActionScope, error: any, user: import("@formio/core").Submission): Promise<any>;
-        executor(scope: import("@formio/appserver-types").ActionScope): Promise<(req: import("@formio/appserver-types").SubmissionRequest, res: import("@formio/appserver-types").SubmissionResponse, next: import("express").NextFunction) => Promise<void>>;
-    };
-    role: {
-        readonly info: {
-            name: string;
-            title: string;
-            description: string;
-            priority: number;
-            defaults: {
-                handler: string[];
-                method: string[];
-            };
-            access: {
-                handler: boolean;
-                method: boolean;
-            };
-        };
-        settingsForm(scope: import("@formio/appserver-types").ActionScope): Promise<({
-            type: string;
-            input: boolean;
-            label: string;
-            key: string;
-            placeholder: string;
-            template: string;
-            dataSrc: string;
-            data: {
-                json: string;
-            };
-            valueProperty: string;
-            multiple: boolean;
-            validate: {
-                required: boolean;
-            };
-        } | {
-            type: string;
-            input: boolean;
-            label: string;
-            key: string;
-            placeholder: string;
-            template: string;
-            dataSrc: string;
-            data: {
-                json: unknown[];
-            };
-            valueProperty: string;
-            multiple: boolean;
-            validate: {
-                required: boolean;
-            };
-        })[]>;
-        executor(scope: import("@formio/appserver-types").ActionScope): Promise<(req: import("@formio/appserver-types").SubmissionRequest, res: import("@formio/appserver-types").SubmissionResponse, next: import("express").NextFunction) => Promise<void | import("@formio/appserver-types").SubmissionResponse>>;
-    };
+    save: import("@formio/appserver-core").Action;
+    login: import("@formio/appserver-core").Action;
+    role: import("@formio/appserver-core").Action;
 };
 export default _default;

package/lib/actions/login/LoginAction.d.ts

@@ -1,109 +1,2 @@
-import { NextFunction } from 'express';
-import { ActionScope, SubmissionRequest, SubmissionResponse } from '@formio/appserver-types';
-import { Submission } from '@formio/core/types';
-export declare const LoginAction: {
-    readonly info: {
-        name: string;
-        title: string;
-        description: string;
-        priority: number;
-        defaults: {
-            handler: string[];
-            method: string[];
-        };
-        access: {
-            handler: boolean;
-            method: boolean;
-        };
-    };
-    /**
-     * The settings form for this action.
-     * @param {*} scope
-     */
-    settingsForm(scope: ActionScope): Promise<({
-        type: string;
-        label: string;
-        key: string;
-        placeholder: string;
-        dataSrc: string;
-        valueProperty: string;
-        data: {
-            json: any;
-        };
-        multiple: boolean;
-        validate: {
-            required: boolean;
-        };
-        input?: undefined;
-        description?: undefined;
-        defaultValue?: undefined;
-        suffix?: undefined;
-    } | {
-        type: string;
-        input: boolean;
-        label: string;
-        key: string;
-        placeholder: string;
-        dataSrc: string;
-        valueProperty: string;
-        data: {
-            json: any;
-        };
-        multiple: boolean;
-        validate: {
-            required: boolean;
-        };
-        description?: undefined;
-        defaultValue?: undefined;
-        suffix?: undefined;
-    } | {
-        type: string;
-        key: string;
-        input: boolean;
-        label: string;
-        description: string;
-        defaultValue: string;
-        placeholder?: undefined;
-        dataSrc?: undefined;
-        valueProperty?: undefined;
-        data?: undefined;
-        multiple?: undefined;
-        validate?: undefined;
-        suffix?: undefined;
-    } | {
-        type: string;
-        key: string;
-        input: boolean;
-        label: string;
-        description: string;
-        defaultValue: string;
-        suffix: string;
-        placeholder?: undefined;
-        dataSrc?: undefined;
-        valueProperty?: undefined;
-        data?: undefined;
-        multiple?: undefined;
-        validate?: undefined;
-    })[]>;
-    /**
-     * Format a string to show how long one must wait.
-     *
-     * @param time - In seconds.
-     * @returns {string}
-     */
-    waitText(time: number): string;
-    /**
-     * Checks the login attempts for a certain login.
-     *
-     * @param user
-     * @param next
-     * @returns {*}
-     */
-    checkAttempts(scope: ActionScope, error: any, user: Submission): Promise<any>;
-    /**
-     * Returns the action middleware.
-     *
-     * @param {*} scope
-     */
-    executor(scope: ActionScope): Promise<(req: SubmissionRequest, res: SubmissionResponse, next: NextFunction) => Promise<void>>;
-};
+import { Action } from '@formio/appserver-core';
+export declare const LoginAction: Action;

package/lib/actions/login/LoginAction.js

@@ -8,18 +8,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LoginAction = void 0;
-const bcryptjs_1 = __importDefault(require("bcryptjs"));
-const has_1 = __importDefault(require("lodash/has"));
-const set_1 = __importDefault(require("lodash/set"));
-const get_1 = __importDefault(require("lodash/get"));
-const unset_1 = __importDefault(require("lodash/unset"));
+const appserver_core_1 = require("@formio/appserver-core");
+const lodash_1 = require("lodash");
 const debug = require('debug')('formio:action:login');
-const error = require('debug')('formio:error');
 exports.LoginAction = {
     // The action information.
     get info() {
@@ -38,22 +31,19 @@ exports.LoginAction = {
             },
         };
     },
-    /**
-     * The settings form for this action.
-     * @param {*} scope
-     */
-    settingsForm(scope) {
+    settingsForm(form) {
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
             const fields = [];
             const resources = [];
-            for (let name in scope.template.resources) {
-                const resource = scope.template.resources[name];
+            for (let name in (_a = form.project.template) === null || _a === void 0 ? void 0 : _a.resources) {
+                const resource = form.project.template.resources[name];
                 resources.push({
                     label: resource.title,
                     value: resource.name
                 });
             }
-            scope.utils.eachComponent(scope.form.components, (component) => {
+            appserver_core_1.Utils.eachComponent((_b = form.form) === null || _b === void 0 ? void 0 : _b.components, (component) => {
                 if (['button'].indexOf(component.type) !== -1) {
                     return;
                 }
@@ -65,223 +55,144 @@ exports.LoginAction = {
             return [
                 {
                     type: 'select',
-                    label: 'Resources',
-                    key: 'resources',
-                    placeholder: 'Select the resources we should login against.',
-                    dataSrc: 'json',
-                    valueProperty: 'value',
-                    data: { json: resources },
-                    multiple: true,
-                    validate: {
-                        required: true,
-                    },
-                },
-                {
-                    type: 'select',
+                    label: 'Authentication Provider',
+                    key: 'provider',
+                    placeholder: 'Select the authentication provider to use for login.',
+                    dataSrc: 'values',
+                    defaultValue: 'local',
                     input: true,
-                    label: 'Username Field',
-                    key: 'username',
-                    placeholder: 'Select the username field',
-                    dataSrc: 'json',
-                    valueProperty: 'value',
-                    data: { json: fields },
-                    multiple: false,
-                    validate: {
-                        required: true,
-                    },
+                    data: {
+                        values: [
+                            { label: 'Local', value: 'local' },
+                            { label: 'OpenID Connect', value: 'oidc' },
+                        ]
+                    }
                 },
                 {
-                    type: 'select',
-                    label: 'Password Field',
-                    key: 'password',
-                    placeholder: 'Select the password field',
-                    dataSrc: 'json',
-                    valueProperty: 'value',
-                    data: { json: fields },
-                    multiple: false,
-                    validate: {
-                        required: true,
+                    type: 'panel',
+                    label: 'Login Settings',
+                    key: 'localSettings',
+                    input: false,
+                    conditional: {
+                        when: 'provider',
+                        eq: 'local',
+                        show: 'true'
                     },
-                },
-                {
-                    type: 'textfield',
-                    key: 'allowedAttempts',
-                    input: true,
-                    label: 'Maximum Login Attempts',
-                    description: 'Use 0 for unlimited attempts',
-                    defaultValue: '5',
-                },
-                {
-                    type: 'textfield',
-                    key: 'attemptWindow',
-                    input: true,
-                    label: 'Login Attempt Time Window',
-                    description: 'This is the window of time to count the login attempts.',
-                    defaultValue: '30',
-                    suffix: 'seconds',
-                },
-                {
-                    type: 'textfield',
-                    key: 'lockWait',
-                    input: true,
-                    label: 'Locked Account Wait Time',
-                    description: 'The amount of time a person needs to wait before they can try to login again.',
-                    defaultValue: '1800',
-                    suffix: 'seconds',
+                    components: [
+                        {
+                            type: 'select',
+                            label: 'Resources',
+                            key: 'resources',
+                            placeholder: 'Select the resources we should login against.',
+                            dataSrc: 'json',
+                            valueProperty: 'value',
+                            data: { json: resources },
+                            multiple: true,
+                            input: true,
+                            validate: {
+                                required: true,
+                            },
+                        },
+                        {
+                            type: 'select',
+                            input: true,
+                            label: 'Username Field',
+                            key: 'username',
+                            placeholder: 'Select the username field',
+                            dataSrc: 'json',
+                            valueProperty: 'value',
+                            data: { json: fields },
+                            multiple: false,
+                            validate: {
+                                required: true,
+                            },
+                        },
+                        {
+                            type: 'select',
+                            label: 'Password Field',
+                            key: 'password',
+                            placeholder: 'Select the password field',
+                            dataSrc: 'json',
+                            valueProperty: 'value',
+                            data: { json: fields },
+                            multiple: false,
+                            input: true,
+                            validate: {
+                                required: true,
+                            },
+                        },
+                        {
+                            type: 'textfield',
+                            key: 'allowedAttempts',
+                            input: true,
+                            label: 'Maximum Login Attempts',
+                            description: 'Use 0 for unlimited attempts',
+                            defaultValue: '5',
+                        },
+                        {
+                            type: 'textfield',
+                            key: 'attemptWindow',
+                            input: true,
+                            label: 'Login Attempt Time Window',
+                            description: 'This is the window of time to count the login attempts.',
+                            defaultValue: '30',
+                            suffix: 'seconds',
+                        },
+                        {
+                            type: 'textfield',
+                            key: 'lockWait',
+                            input: true,
+                            label: 'Locked Account Wait Time',
+                            description: 'The amount of time a person needs to wait before they can try to login again.',
+                            defaultValue: '1800',
+                            suffix: 'seconds',
+                        }
+                    ]
                 },
             ];
         });
     },
-    /**
-     * Format a string to show how long one must wait.
-     *
-     * @param time - In seconds.
-     * @returns {string}
-     */
-    waitText(time) {
-        return (time > 60) ? `${(time / 60)} minutes` : `${time} seconds`;
-    },
-    /**
-     * Checks the login attempts for a certain login.
-     *
-     * @param user
-     * @param next
-     * @returns {*}
-     */
-    checkAttempts(scope, error, user) {
+    executor(actionForm, action, handler, method) {
         return __awaiter(this, void 0, void 0, function* () {
-            const action = scope.action;
-            if (!user || !user._id || !action.settings.allowedAttempts) {
-                return;
-            }
-            const allowedAttempts = parseInt(action.settings.allowedAttempts, 10);
-            if (Number.isNaN(allowedAttempts) || allowedAttempts === 0) {
-                return;
-            }
-            // Initialize the login metadata.
-            if (!(0, has_1.default)(user, 'metadata.login')) {
-                (0, set_1.default)(user, 'metadata.login', {});
-            }
-            const now = (new Date()).getTime();
-            const { login: loginMetadata, } = user.metadata;
-            const lastAttempt = parseInt(loginMetadata.last, 10) || 0;
-            // See if the login is locked.
-            if (loginMetadata.locked) {
-                // Get how long they must wait to be locked out.
-                let lockWait = parseInt(action.settings.lockWait, 10) || 1800;
-                // Normalize to milliseconds.
-                lockWait *= 1000;
-                // See if the time has expired.
-                if ((lastAttempt + lockWait) < now) {
-                    // Reset the locked state and attempts totals.
-                    loginMetadata.attempts = 0;
-                    loginMetadata.locked = false;
-                    loginMetadata.last = now;
-                }
-                else {
-                    const howLong = (lastAttempt + lockWait) - now;
-                    return `You must wait ${exports.LoginAction.waitText(howLong / 1000)} before you can login.`;
-                }
+            var _a, _b, _c, _d;
+            let loginProvider = null;
+            if (!action.settings.provider || action.settings.provider !== 'local') {
+                loginProvider = new appserver_core_1.LocalAuthProvider(actionForm.project, (0, lodash_1.defaultsDeep)((_b = (_a = actionForm.project) === null || _a === void 0 ? void 0 : _a.config) === null || _b === void 0 ? void 0 : _b.auth, {
+                    local: action.settings
+                }));
             }
-            else if (error) {
-                let attemptWindow = parseInt(action.settings.attemptWindow, 10) || 30;
-                // Normalize to milliseconds.
-                attemptWindow *= 1000;
-                // Determine the login attempts within a certain window.
-                const withinWindow = lastAttempt ? ((lastAttempt + attemptWindow) > now) : false;
-                if (withinWindow) {
-                    const attempts = (parseInt(loginMetadata.attempts, 10) || 0) + 1;
-                    // If they exceeded the login attempts.
-                    if (attempts >= allowedAttempts) {
-                        const lockWait = parseInt(action.settings.lockWait, 10) || 1800;
-                        error = `Maximum Login attempts. Please wait ${exports.LoginAction.waitText(lockWait)} before trying again.`;
-                        loginMetadata.locked = true;
-                    }
-                    // Set the login attempts.
-                    loginMetadata.attempts = attempts;
-                }
-                else {
-                    loginMetadata.attempts = 0;
-                    loginMetadata.last = now;
-                }
+            else if (action.settings.provider === 'oidc') {
+                loginProvider = new appserver_core_1.OIDCProvider(actionForm.project, (0, lodash_1.defaultsDeep)((_d = (_c = actionForm.project) === null || _c === void 0 ? void 0 : _c.config) === null || _d === void 0 ? void 0 : _d.auth, {
+                    oidc: action.settings
+                }));
             }
-            else {
-                // If there was no error, then reset the attempts to zero.
-                loginMetadata.attempts = 0;
-                loginMetadata.last = now;
+            if (loginProvider === null || loginProvider === void 0 ? void 0 : loginProvider.initialize) {
+                yield loginProvider.initialize();
             }
-            // Update the user record
-            yield scope.db.update(scope, user._id.toString(), user);
-            return error;
-        });
-    },
-    /**
-     * Returns the action middleware.
-     *
-     * @param {*} scope
-     */
-    executor(scope) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const action = scope.action;
-            const userfield = action.settings.username;
-            const passfield = action.settings.password;
-            const forms = yield scope.utils.getForms(scope, action.settings.resources);
             return (req, res, next) => __awaiter(this, void 0, void 0, function* () {
-                var _a, _b;
                 debug('Login Action');
-                const username = (0, get_1.default)((_a = (req.originalBody || req.body)) === null || _a === void 0 ? void 0 : _a.data, userfield);
-                const password = (0, get_1.default)((_b = (req.originalBody || req.body)) === null || _b === void 0 ? void 0 : _b.data, passfield, '');
-                if (!username) {
-                    error('Missing username');
-                    return next('Missing username');
-                }
-                if (!password) {
-                    error('Missing password');
-                    return next('Missing password');
+                const result = yield (loginProvider === null || loginProvider === void 0 ? void 0 : loginProvider.login(req.auth, req.body, actionForm));
+                if (!result) {
+                    return next('Unable to login');
                 }
-                // Find the user
-                debug('Finding user', `${userfield} = ${username}`);
-                const user = yield scope.utils.findUser(scope, forms, `data.${userfield}`, username);
-                if (!user) {
-                    error('User not found');
-                    return next('User or password was incorrect');
+                if (typeof result === 'string') {
+                    // If a string is returned, then it is a redirect.
+                    return res.redirect(result);
                 }
-                // Get the current password hash.
-                const hash = (0, get_1.default)(user.data, passfield);
-                if (!hash || !hash.hash) {
-                    error('User does not have a password');
-                    return next('Your account does not have a password. You must reset your password to login.');
-                }
-                // Compare with bcrypt.
-                debug('Comparing password');
-                bcryptjs_1.default.compare(password, hash.hash, (err, value) => __awaiter(this, void 0, void 0, function* () {
-                    if (err) {
-                        error(err);
-                        return next(err);
-                    }
-                    // Check the login attempts.
-                    const errorAttempts = yield exports.LoginAction.checkAttempts(scope, !value, user);
-                    if (errorAttempts) {
-                        error(errorAttempts);
-                        return next(errorAttempts === true ? 'User or password was incorrect' : errorAttempts);
-                    }
-                    // Unset the password field before we create a token from it.
-                    (0, unset_1.default)(user.data, passfield);
-                    // Set the user object.
-                    req.user = user;
-                    req.token = yield scope.auth.token(scope.utils.tokenFromUser(user), scope.config.auth.secret, scope.config.auth.expire);
-                    // Set the auth headers.
-                    res.setHeader('x-jwt-token', req.token);
-                    req.headers['x-jwt-token'] = req.token;
+                if (typeof result === 'object') {
+                    res.set('x-jwt-token', req.auth.token);
                     if (res.resource) {
-                        res.resource.item = req.user;
+                        res.resource.item = req.auth.user;
                     }
                     else {
-                        res.resource = { status: 200, item: req.user };
+                        res.resource = { status: 200, item: req.auth.user };
                     }
-                    debug('Login Successful', req.user);
+                    debug('Login Successful', req.auth.user);
                     next();
-                }));
+                }
+                else {
+                    return next('Unable to login');
+                }
             });
         });
     }