@flink-app/generic-auth-plugin 0.3.7 → 0.3.9

package/.flink/generatedHandlers.ts

@@ -1,7 +1,8 @@
-// Generated Wed Oct 12 2022 10:04:17 GMT+0200 (Central European Summer Time)
+// Generated Sun Oct 16 2022 13:16:37 GMT+0200 (Central European Summer Time)
 import { autoRegisteredHandlers, HttpMethod } from "@flink-app/flink";
 import * as UserCreate_0 from "../src/handlers/UserCreate";
 import * as UserLogin_0 from "../src/handlers/UserLogin";
+import * as UserLoginByToken_0 from "../src/handlers/UserLoginByToken";
 import * as UserPasswordPut_0 from "../src/handlers/UserPasswordPut";
 import * as UserPasswordResetComplete_0 from "../src/handlers/UserPasswordResetComplete";
 import * as UserPasswordResetForm_0 from "../src/handlers/UserPasswordResetForm";

package/.flink/generatedRepos.ts

@@ -1,4 +1,4 @@
-// Generated Wed Oct 12 2022 10:04:17 GMT+0200 (Central European Summer Time)
+// Generated Sun Oct 16 2022 13:16:37 GMT+0200 (Central European Summer Time)
   import { autoRegisteredRepos } from "@flink-app/flink";
   export const repos = [];
   autoRegisteredRepos.push(...repos);

package/.flink/schemas/schemas.json

@@ -127,6 +127,66 @@
         "status"
       ]
     },
+    "UserLoginByToken_7_ReqSchema": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "token": {
+          "type": "string"
+        },
+        "code": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "code",
+        "token"
+      ]
+    },
+    "UserLoginByToken_7_ResSchema": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "status": {
+          "type": "string",
+          "enum": [
+            "success",
+            "failed",
+            "requiresValidation"
+          ]
+        },
+        "user": {
+          "type": "object",
+          "properties": {
+            "_id": {
+              "type": "string"
+            },
+            "username": {
+              "type": "string"
+            },
+            "token": {
+              "type": "string"
+            },
+            "profile": {
+              "$ref": "#/definitions/UserProfile"
+            }
+          },
+          "required": [
+            "_id",
+            "username",
+            "token",
+            "profile"
+          ],
+          "additionalProperties": false
+        },
+        "validationToken": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "status"
+      ]
+    },
     "UserPasswordPut_7_ReqSchema": {
       "type": "object",
       "additionalProperties": false,

package/.flink/schemas/schemas.ts

@@ -2,6 +2,7 @@ import { UserCreateReq } from "../../src/schemas/UserCreateReq";
 import { UserCreateRes } from "../../src/schemas/UserCreateRes";
 import { UserLoginReq } from "../../src/schemas/UserLoginReq";
 import { UserLoginRes } from "../../src/schemas/UserLoginRes";
+import { UserLoginByTokenReq } from "../../src/schemas/UserLoginByTokenReq";
 import { UserPasswordChangeReq } from "../../src/schemas/UserPasswordChangeReq";
 import { UserPasswordChangeRes } from "../../src/schemas/UserPasswordChangeRes";
 import { UserPasswordResetCompleteReq } from "../../src/schemas/UserPasswordResetCompleteReq";
@@ -29,7 +30,7 @@ import { PutManagementUserRolesByUseridRes } from "../../src/schemas/Management/
 import { PutManagementUserUsernameByUseridReq } from "../../src/schemas/Management/PutUserUsernameByUseridReq";
 import { PutManagementUserUsernameByUseridRes } from "../../src/schemas/Management/PutUserUsernameByUseridRes";
 
-// Generated Wed Oct 12 2022 10:04:19 GMT+0200 (Central European Summer Time)
+// Generated Sun Oct 16 2022 13:16:45 GMT+0200 (Central European Summer Time)
 export interface UserCreate_7_ReqSchema extends UserCreateReq {}
 
 export interface UserCreate_7_ResSchema extends UserCreateRes {}
@@ -38,6 +39,10 @@ export interface UserLogin_7_ReqSchema extends UserLoginReq {}
 
 export interface UserLogin_7_ResSchema extends UserLoginRes {}
 
+export interface UserLoginByToken_7_ReqSchema extends UserLoginByTokenReq {}
+
+export interface UserLoginByToken_7_ResSchema extends UserLoginRes {}
+
 export interface UserPasswordPut_7_ReqSchema extends UserPasswordChangeReq {}
 
 export interface UserPasswordPut_7_ResSchema extends UserPasswordChangeRes {}

package/.flink/start.ts

@@ -1,4 +1,4 @@
-// Generated Wed Oct 12 2022 10:04:18 GMT+0200 (Central European Summer Time)
+// Generated Sun Oct 16 2022 13:16:38 GMT+0200 (Central European Summer Time)
 import "./generatedHandlers";
 import "./generatedRepos";
 import "../src/index";

package/dist/.flink/generatedHandlers.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.handlers = void 0;
-// Generated Wed Oct 12 2022 10:04:17 GMT+0200 (Central European Summer Time)
+// Generated Sun Oct 16 2022 13:16:37 GMT+0200 (Central European Summer Time)
 var flink_1 = require("@flink-app/flink");
 exports.handlers = [];
 flink_1.autoRegisteredHandlers.push.apply(flink_1.autoRegisteredHandlers, exports.handlers);

package/dist/.flink/generatedRepos.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.repos = void 0;
-// Generated Wed Oct 12 2022 10:04:17 GMT+0200 (Central European Summer Time)
+// Generated Sun Oct 16 2022 13:16:37 GMT+0200 (Central European Summer Time)
 var flink_1 = require("@flink-app/flink");
 exports.repos = [];
 flink_1.autoRegisteredRepos.push.apply(flink_1.autoRegisteredRepos, exports.repos);

package/dist/.flink/schemas/schemas.d.ts

@@ -2,6 +2,7 @@ import { UserCreateReq } from "../../src/schemas/UserCreateReq";
 import { UserCreateRes } from "../../src/schemas/UserCreateRes";
 import { UserLoginReq } from "../../src/schemas/UserLoginReq";
 import { UserLoginRes } from "../../src/schemas/UserLoginRes";
+import { UserLoginByTokenReq } from "../../src/schemas/UserLoginByTokenReq";
 import { UserPasswordChangeReq } from "../../src/schemas/UserPasswordChangeReq";
 import { UserPasswordChangeRes } from "../../src/schemas/UserPasswordChangeRes";
 import { UserPasswordResetCompleteReq } from "../../src/schemas/UserPasswordResetCompleteReq";
@@ -36,6 +37,10 @@ export interface UserLogin_7_ReqSchema extends UserLoginReq {
 }
 export interface UserLogin_7_ResSchema extends UserLoginRes {
 }
+export interface UserLoginByToken_7_ReqSchema extends UserLoginByTokenReq {
+}
+export interface UserLoginByToken_7_ResSchema extends UserLoginRes {
+}
 export interface UserPasswordPut_7_ReqSchema extends UserPasswordChangeReq {
 }
 export interface UserPasswordPut_7_ResSchema extends UserPasswordChangeRes {

package/dist/.flink/schemas/schemas.json

@@ -127,6 +127,66 @@
                 "status"
             ]
         },
+        "UserLoginByToken_7_ReqSchema": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "token": {
+                    "type": "string"
+                },
+                "code": {
+                    "type": "string"
+                }
+            },
+            "required": [
+                "code",
+                "token"
+            ]
+        },
+        "UserLoginByToken_7_ResSchema": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "status": {
+                    "type": "string",
+                    "enum": [
+                        "success",
+                        "failed",
+                        "requiresValidation"
+                    ]
+                },
+                "user": {
+                    "type": "object",
+                    "properties": {
+                        "_id": {
+                            "type": "string"
+                        },
+                        "username": {
+                            "type": "string"
+                        },
+                        "token": {
+                            "type": "string"
+                        },
+                        "profile": {
+                            "$ref": "#/definitions/UserProfile"
+                        }
+                    },
+                    "required": [
+                        "_id",
+                        "username",
+                        "token",
+                        "profile"
+                    ],
+                    "additionalProperties": false
+                },
+                "validationToken": {
+                    "type": "string"
+                }
+            },
+            "required": [
+                "status"
+            ]
+        },
         "UserPasswordPut_7_ReqSchema": {
             "type": "object",
             "additionalProperties": false,

package/dist/.flink/start.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-// Generated Wed Oct 12 2022 10:04:18 GMT+0200 (Central European Summer Time)
+// Generated Sun Oct 16 2022 13:16:38 GMT+0200 (Central European Summer Time)
 require("./generatedHandlers");
 require("./generatedRepos");
 require("../src/index");

package/dist/src/coreFunctions.d.ts

@@ -7,6 +7,7 @@ import { UserProfile } from "./schemas/UserProfile";
 import { UserPasswordChangeRes } from "./schemas/UserPasswordChangeRes";
 import { UserPasswordResetStartRes } from "./schemas/UserPasswordResetStartRes";
 import { UserPasswordResetCompleteRes } from "./schemas/UserPasswordResetCompleteRes";
+import { GenericAuthsmsOptions } from "./genericAuthPluginOptions";
 export declare function getJtwTokenPlugin(secret: string, rolePermissions?: {
     [role: string]: string[];
 }, passwordPolicy?: RegExp): JwtAuthPlugin;
@@ -16,9 +17,10 @@ export declare function createUser(repo: FlinkRepo<any, User>, auth: JwtAuthPlug
         salt: string;
     } | null>;
 }): Promise<UserCreateRes>;
+export declare function loginByToken(repo: FlinkRepo<any, User>, auth: JwtAuthPlugin, token: string, code: string, jwtSecret: string): Promise<UserLoginRes>;
 export declare function loginUser(repo: FlinkRepo<any, User>, auth: JwtAuthPlugin, username: string, password: string | undefined, validatePasswordMethod?: {
     (password: string, hash: string, salt: string): Promise<boolean>;
-}): Promise<UserLoginRes>;
+}, smsOptions?: GenericAuthsmsOptions): Promise<UserLoginRes>;
 export declare function changePassword(repo: FlinkRepo<any, User>, auth: JwtAuthPlugin, userId: string, newPassword: string, createPasswordHashAndSaltMethod?: {
     (password: string): Promise<{
         hash: string;

package/dist/src/coreFunctions.js

@@ -39,8 +39,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.passwordResetComplete = exports.passwordResetStart = exports.changePassword = exports.loginUser = exports.createUser = exports.getJtwTokenPlugin = void 0;
-var flink_1 = require("@flink-app/flink");
+exports.passwordResetComplete = exports.passwordResetStart = exports.changePassword = exports.loginUser = exports.loginByToken = exports.createUser = exports.getJtwTokenPlugin = void 0;
 var jwt_auth_plugin_1 = require("@flink-app/jwt-auth-plugin");
 var jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
 function getJtwTokenPlugin(secret, rolePermissions, passwordPolicy) {
@@ -119,6 +118,11 @@ function createUser(repo, auth, username, password, authentificationMethod, role
                     return [4 /*yield*/, auth.createToken({ username: username.toLowerCase(), _id: user._id }, roles)];
                 case 8:
                     token = _a.sent();
+                    if (user.authentificationMethod == "sms") {
+                        return [2 /*return*/, {
+                                status: "success",
+                            }];
+                    }
                     return [2 /*return*/, {
                             status: "success",
                             user: {
@@ -132,9 +136,47 @@ function createUser(repo, auth, username, password, authentificationMethod, role
     });
 }
 exports.createUser = createUser;
-function loginUser(repo, auth, username, password, validatePasswordMethod) {
+function loginByToken(repo, auth, token, code, jwtSecret) {
+    return __awaiter(this, void 0, void 0, function () {
+        var payload, user, authToken;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    try {
+                        payload = jsonwebtoken_1.default.verify(token, jwtSecret + ":" + code);
+                    }
+                    catch (ex) {
+                        return [2 /*return*/, { status: "failed" }];
+                    }
+                    if (payload.type != "smsLogin") {
+                        return [2 /*return*/, { status: "failed" }];
+                    }
+                    return [4 /*yield*/, repo.getById(payload.userId)];
+                case 1:
+                    user = _a.sent();
+                    if (user == null) {
+                        return [2 /*return*/, { status: "failed" }];
+                    }
+                    return [4 /*yield*/, auth.createToken({ username: user.username.toLowerCase(), _id: user._id }, user.roles)];
+                case 2:
+                    authToken = _a.sent();
+                    return [2 /*return*/, {
+                            status: "success",
+                            user: {
+                                _id: user._id,
+                                username: user.username,
+                                token: authToken,
+                                profile: user.profile,
+                            },
+                        }];
+            }
+        });
+    });
+}
+exports.loginByToken = loginByToken;
+function loginUser(repo, auth, username, password, validatePasswordMethod, smsOptions) {
     return __awaiter(this, void 0, void 0, function () {
-        var user, valid, ex_1, token;
+        var user, valid, ex_1, code, payload, secret, options, token, token;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, repo.getOne({ username: username.toLowerCase() })];
@@ -169,8 +211,27 @@ function loginUser(repo, auth, username, password, validatePasswordMethod) {
                     _a.label = 9;
                 case 9:
                     if (user.authentificationMethod == "sms") {
-                        flink_1.log.error("SMS login is not yet impleted.");
-                        return [2 /*return*/, { status: "failed" }];
+                        if (!smsOptions)
+                            throw "SMS options must be specified to use SMS login";
+                        code = smsOptions.codeType == "numeric" ? generate(smsOptions.codeLength) : generateString(smsOptions.codeLength);
+                        smsOptions.smsClient.send({
+                            to: [user.username],
+                            from: smsOptions.smsFrom,
+                            message: smsOptions.smsMessage.replace("{{code}}", code)
+                        });
+                        payload = {
+                            type: "smsLogin",
+                            userId: user._id,
+                        };
+                        secret = smsOptions.jwtToken + ":" + code;
+                        options = {
+                            expiresIn: "1h",
+                        };
+                        token = jsonwebtoken_1.default.sign(payload, secret, options);
+                        return [2 /*return*/, {
+                                status: "success",
+                                validationToken: token
+                            }];
                     }
                     if (!valid) return [3 /*break*/, 11];
                     return [4 /*yield*/, auth.createToken({ username: username.toLowerCase(), _id: user._id }, user.roles)];
@@ -333,3 +394,12 @@ function generate(n) {
     var number = Math.floor(Math.random() * (max - min + 1)) + min;
     return ("" + number).substring(add);
 }
+function generateString(length) {
+    var characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789';
+    var result = ' ';
+    var charactersLength = characters.length;
+    for (var i = 0; i < length; i++) {
+        result += characters.charAt(Math.floor(Math.random() * charactersLength));
+    }
+    return result;
+}

package/dist/src/genericAuthContext.d.ts

@@ -8,11 +8,13 @@ import { UserPasswordChangeRes } from "./schemas/UserPasswordChangeRes";
 import { UserPasswordResetSettings } from "./schemas/UserPasswordResetSettings";
 import { UserPasswordResetStartRes } from "./schemas/UserPasswordResetStartRes";
 import { UserPasswordResetCompleteRes } from "./schemas/UserPasswordResetCompleteRes";
+import { GenericAuthsmsOptions } from "./genericAuthPluginOptions";
 export interface genericAuthContext {
     genericAuthPlugin: {
         loginUser(repo: FlinkRepo<any, User>, auth: JwtAuthPlugin, username: string, password?: string, validatePasswordMethod?: {
             (password: string, hash: string, salt: string): Promise<boolean>;
-        }): Promise<UserLoginRes>;
+        }, smsOptions?: GenericAuthsmsOptions): Promise<UserLoginRes>;
+        loginByToken(repo: FlinkRepo<any, User>, auth: JwtAuthPlugin, token: string, code: string, jwtSecret: string): Promise<UserLoginRes>;
         createUser(repo: FlinkRepo<any, User>, auth: JwtAuthPlugin, username: string, password: string, authentificationMethod: "password" | "sms", roles: string[], profile: UserProfile, createPasswordHashAndSaltMethod?: {
             (password: string): Promise<{
                 hash: string;
@@ -44,5 +46,6 @@ export interface genericAuthContext {
             (password: string, hash: string, salt: string): Promise<boolean>;
         };
         usernameFormat: RegExp;
+        smsOptions?: GenericAuthsmsOptions;
     };
 }

package/dist/src/genericAuthPluginOptions.d.ts

@@ -1,4 +1,5 @@
 import { UserPasswordResetSettings } from "./schemas/UserPasswordResetSettings";
+import { client as smsClient } from "@flink-app/sms-plugin";
 export interface GenericAuthPluginOptions {
     repoName: string;
     enableRoutes?: boolean;
@@ -20,4 +21,13 @@ export interface GenericAuthPluginOptions {
         (password: string, hash: string, salt: string): Promise<boolean>;
     };
     usernameFormat?: RegExp;
+    sms?: GenericAuthsmsOptions;
+}
+export interface GenericAuthsmsOptions {
+    smsClient: smsClient;
+    smsFrom: string;
+    smsMessage: string;
+    jwtToken: string;
+    codeType: "numeric" | "alphanumeric";
+    codeLength: number;
 }

package/dist/src/handlers/UserLogin.js

@@ -47,7 +47,7 @@ var userLoginHandler = function (_a) {
                 case 0:
                     pluginName = origin || "genericAuthPlugin";
                     repo = ctx.repos[ctx.plugins[pluginName].repoName];
-                    return [4 /*yield*/, ctx.plugins.genericAuthPlugin.loginUser(repo, ctx.auth, req.body.username, req.body.password, ctx.plugins.genericAuthPlugin.validatePasswordMethod)];
+                    return [4 /*yield*/, ctx.plugins.genericAuthPlugin.loginUser(repo, ctx.auth, req.body.username, req.body.password, ctx.plugins.genericAuthPlugin.validatePasswordMethod, ctx.plugins[pluginName].smsOptions)];
                 case 1:
                     loginRespons = _b.sent();
                     if (loginRespons.status != "success") {

package/dist/src/handlers/UserLoginByToken.d.ts

@@ -0,0 +1,8 @@
+import { FlinkContext, Handler } from "@flink-app/flink";
+import { genericAuthContext } from "../genericAuthContext";
+import { UserLoginByTokenReq } from "../schemas/UserLoginByTokenReq";
+import { UserLoginRes } from "../schemas/UserLoginRes";
+declare const userLoginHandler: Handler<FlinkContext<genericAuthContext>, UserLoginByTokenReq, UserLoginRes>;
+export default userLoginHandler;
+export declare const __assumedHttpMethod = "", __file = "UserLoginByToken.ts", __query: never[], __params: never[];
+export declare const __schemas: any;

package/dist/src/handlers/UserLoginByToken.js

@@ -0,0 +1,69 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.__schemas = exports.__params = exports.__query = exports.__file = exports.__assumedHttpMethod = void 0;
+var flink_1 = require("@flink-app/flink");
+var userLoginHandler = function (_a) {
+    var ctx = _a.ctx, req = _a.req, origin = _a.origin;
+    return __awaiter(void 0, void 0, void 0, function () {
+        var pluginName, repo, loginRespons;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    pluginName = origin || "genericAuthPlugin";
+                    repo = ctx.repos[ctx.plugins[pluginName].repoName];
+                    return [4 /*yield*/, ctx.plugins.genericAuthPlugin.loginByToken(repo, ctx.auth, req.body.token, req.body.code, ctx.plugins[pluginName].smsOptions.jwtToken)];
+                case 1:
+                    loginRespons = _b.sent();
+                    if (loginRespons.status != "success") {
+                        switch (loginRespons.status) {
+                            case "failed":
+                                return [2 /*return*/, flink_1.unauthorized("Invalid token or code", loginRespons.status)];
+                        }
+                    }
+                    return [2 /*return*/, {
+                            data: loginRespons,
+                            status: 200,
+                        }];
+            }
+        });
+    });
+};
+exports.default = userLoginHandler;
+exports.__assumedHttpMethod = "", exports.__file = "UserLoginByToken.ts", exports.__query = [], exports.__params = [];
+exports.__schemas = { reqSchema: { "type": "object", "additionalProperties": false, "properties": { "token": { "type": "string" }, "code": { "type": "string" } }, "required": ["code", "token"] }, resSchema: { "type": "object", "additionalProperties": false, "properties": { "status": { "type": "string", "enum": ["success", "failed", "requiresValidation"] }, "user": { "type": "object", "properties": { "_id": { "type": "string" }, "username": { "type": "string" }, "token": { "type": "string" }, "profile": { "type": "object" } }, "required": ["_id", "username", "token", "profile"], "additionalProperties": false }, "validationToken": { "type": "string" } }, "required": ["status"] } };

package/dist/src/index.js

@@ -26,6 +26,7 @@ var genericAuthPlugin = function (options) {
         init: function (app) { return init_1.init(app, options); },
         ctx: {
             loginUser: coreFunctions_1.loginUser,
+            loginByToken: coreFunctions_1.loginByToken,
             createUser: coreFunctions_1.createUser,
             changePassword: coreFunctions_1.changePassword,
             passwordResetStart: coreFunctions_1.passwordResetStart,
@@ -35,6 +36,7 @@ var genericAuthPlugin = function (options) {
             createPasswordHashAndSaltMethod: options.createPasswordHashAndSaltMethod,
             validatePasswordMethod: options.validatePasswordMethod,
             usernameFormat: options.usernameFormat || /.{1,}$/,
+            smsOptions: options.sms
         },
     };
 };

package/dist/src/init.js

@@ -22,6 +22,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.init = void 0;
 var flink_1 = require("@flink-app/flink");
 var userLoginHandler = __importStar(require("./handlers/UserLogin"));
+var userLoginByTokenHandler = __importStar(require("./handlers/UserLoginByToken"));
 var userCreateHandler = __importStar(require("./handlers/UserCreate"));
 var getProfileHandler = __importStar(require("./handlers/UserProfileGet"));
 var putUserProfileHandler = __importStar(require("./handlers/UserProfilePut"));
@@ -49,6 +50,14 @@ function init(app, options) {
             docs: "Authenticates a user",
             origin: options.pluginId,
         });
+        if (options.sms) {
+            app.addHandler(userLoginByTokenHandler, {
+                method: flink_1.HttpMethod.post,
+                path: options.baseUrl + "/login-by-token",
+                docs: "Authenticates a user by token",
+                origin: options.pluginId,
+            });
+        }
         if (options.enableUserCreation) {
             app.addHandler(userCreateHandler, {
                 method: flink_1.HttpMethod.post,

package/dist/src/schemas/UserLoginByTokenReq.d.ts

@@ -0,0 +1,4 @@
+export interface UserLoginByTokenReq {
+    token: string;
+    code: string;
+}

package/dist/src/schemas/UserLoginByTokenReq.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flink-app/generic-auth-plugin",
-  "version": "0.3.7",
+  "version": "0.3.9",
   "description": "Flink plugin that provides a generic user authentification solution.",
   "scripts": {
     "test": "echo \"Error: no test specified\"",
@@ -16,18 +16,19 @@
   "types": "dist/src/index.d.ts",
   "main": "dist/src/index.js",
   "dependencies": {
-    "@flink-app/email-plugin": "^0.3.7",
-    "@flink-app/jwt-auth-plugin": "^0.3.7",
-    "@flink-app/management-api-plugin": "^0.3.7",
+    "@flink-app/email-plugin": "^0.3.8",
+    "@flink-app/jwt-auth-plugin": "^0.3.8",
+    "@flink-app/management-api-plugin": "^0.3.8",
+    "@flink-app/sms-plugin": "^0.3.9",
     "handlebars": "^4.7.7",
     "jsonwebtoken": "^8.5.1"
   },
   "devDependencies": {
-    "@flink-app/flink": "^0.3.7",
+    "@flink-app/flink": "^0.3.8",
     "@types/jsonwebtoken": "^8.5.2",
     "@types/node": "^15.6.2",
     "ts-node": "^9.1.1",
     "typescript": "^4.2.4"
   },
-  "gitHead": "e61be35839aa8d459dc07613d9bfa919570361f2"
+  "gitHead": "660a90494e67b768a560c3618d8a3da3cc5d5144"
 }

package/readme.md

@@ -742,3 +742,150 @@ export interface Profile{
     type : myType
 }
 ```
+
+
+
+## Using SMS login
+
+
+### prerequisites
+- A SMS client must be setup using the [sms-plugin](https://github.com/FrostDigital/flink-framework/tree/main/packages/sms-plugin)
+
+
+### Setup
+- Configure this plugin by setting the sms option:
+
+
+```
+import { FlinkApp } from "@flink-app/flink";
+import { Ctx } from "./Ctx";
+
+import { getJtwTokenPlugin, genericAuthPlugin } from "@flink-app/generic-auth-plugin"
+
+const authPlugin = getJtwTokenPlugin("secret");
+
+function start() {
+  var app = new FlinkApp<Ctx>({
+    name: "My flink app",
+    debug: true,
+    auth : authPlugin,
+    db: {
+      uri: "mongodb://localhost:27017/my-flink-app",
+    },
+    plugins: [
+      genericAuthPlugin({
+        ...
+
+
+          sms : {
+            smsClient: new sms46elksClient({
+              username: "XXX",
+              password: "YYY",
+            }),
+            smsFrom: "AUTHMSG",
+            smsMessage: "Your code is {{code}}",
+            jwtToken: "secret-to-sign-jwt-tokens",
+            codeType: "numeric",
+            codeLength: 6
+          }
+
+
+        ...
+
+        }
+      }),
+    ],
+  })
+  app.start();
+}
+start();
+```
+
+
+
+### Register users with SMS-login
+To use SMS-login on a user, the user must be created with the `authentificationMethod` option set to sms.
+Username also have to be the users phone number in the "+4671234567" format.
+
+### POST /user/create
+
+Create a user that can login via SMS
+
+#### Request data:
+
+```
+{
+  "username" : "+4671234567",
+ "authentificationMethod" : "sms" 
+}
+```
+
+#### Response example
+
+```
+{
+  "data": {
+    "status": "success",
+  },
+```
+
+
+
+### Initiate login
+Initiate a user login by sending a SMS with the code to the user.
+Please note that the user HAVE to be created with the  `authentificationMethod` option set to sms.
+
+### POST /user/login
+
+
+#### Request data:
+
+```
+{
+  "username" : "+4671234567",
+}
+```
+
+#### Response example
+
+```
+{
+  "data": {
+    "status": "success",
+    "validationToken": "TOKEN"
+  },
+}
+
+```
+
+### Login
+Finalize the login by sending the token received above, and the code received via SMS.
+
+### POST /user/login-by-token
+
+
+#### Request data:
+
+```
+{
+  "token" : "TOKEN",
+  "code" : "code"
+ }
+```
+
+#### Response example
+
+```
+{
+  "data": {
+    "status": "success",
+    "user": {
+      "_id": "1234...",
+      "username": "+4671234567",
+      "token": "Token",
+      "profile": {}
+    }
+  },
+  "status": 200
+}
+```

package/src/coreFunctions.ts

@@ -10,6 +10,7 @@ import { UserPasswordResetStartRes } from "./schemas/UserPasswordResetStartRes";
 import { UserPasswordResetCompleteRes } from "./schemas/UserPasswordResetCompleteRes";
 
 import jsonwebtoken from "jsonwebtoken";
+import { GenericAuthsmsOptions } from "./genericAuthPluginOptions";
 
 export function getJtwTokenPlugin(secret: string, rolePermissions?: { [role: string]: string[] }, passwordPolicy?: RegExp) {
     if (passwordPolicy == undefined) {
@@ -87,6 +88,12 @@ export async function createUser(
 
     const token = await auth.createToken({ username: username.toLowerCase(), _id: user._id }, roles);
 
+    if (user.authentificationMethod == "sms") {
+        return {
+            status: "success",
+        };
+    }
+
     return {
         status: "success",
         user: {
@@ -97,6 +104,51 @@ export async function createUser(
     };
 }
 
+export async function loginByToken(
+    repo: FlinkRepo<any, User>,
+    auth: JwtAuthPlugin,
+    token : string,
+    code : string,
+    jwtSecret : string
+
+): Promise<UserLoginRes> {
+
+
+    let payload : { type : string, userId : string};
+    try{
+        payload = jsonwebtoken.verify(token, jwtSecret + ":" + code) as { type : string, userId : string};
+    }catch(ex){
+        return { status: "failed" };
+    }
+     
+
+    if(payload.type != "smsLogin"){
+        return { status: "failed" };
+    }
+
+    
+
+    const user = await repo.getById(payload.userId)
+    if (user == null) {
+        return { status: "failed" };
+    }
+
+
+    const authToken = await auth.createToken({ username: user.username.toLowerCase(), _id: user._id }, user.roles);
+
+    return {
+        status: "success",
+        user: {
+            _id: user._id,
+            username: user.username,
+            token : authToken,
+            profile: user.profile,
+        },
+    };    
+
+}
+
+
 export async function loginUser(
     repo: FlinkRepo<any, User>,
     auth: JwtAuthPlugin,
@@ -104,7 +156,8 @@ export async function loginUser(
     password: string | undefined,
     validatePasswordMethod?: {
         (password: string, hash: string, salt: string): Promise<boolean>;
-    }
+    },
+    smsOptions? : GenericAuthsmsOptions
 ): Promise<UserLoginRes> {
     const user = await repo.getOne({ username: username.toLowerCase() });
     if (user == null) {
@@ -130,8 +183,35 @@ export async function loginUser(
         }
     }
     if (user.authentificationMethod == "sms") {
-        log.error("SMS login is not yet impleted.");
-        return { status: "failed" };
+        if(!smsOptions) throw "SMS options must be specified to use SMS login"
+        let code = smsOptions.codeType == "numeric" ? generate(smsOptions.codeLength) : generateString(smsOptions.codeLength);
+        smsOptions.smsClient.send({
+            to : [user.username],
+            from : smsOptions.smsFrom,
+            message : smsOptions.smsMessage.replace("{{code}}", code)
+        })
+
+        const payload = {
+            type: "smsLogin",
+            userId: user._id,
+        };
+    
+        const secret = smsOptions.jwtToken + ":" + code;
+    
+        const options: jsonwebtoken.SignOptions = {
+            expiresIn: "1h",
+        };
+    
+        const token = jsonwebtoken.sign(payload, secret, options);
+
+
+        return {
+            status: "success",
+            validationToken : token
+        };
+
+
+
     }
 
     if (valid) {
@@ -297,3 +377,17 @@ function generate(n: number): string {
 
     return ("" + number).substring(add);
 }
+
+
+
+
+function generateString(length : number) {
+    const characters ='ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789';
+    let result = ' ';
+    const charactersLength = characters.length;
+    for ( let i = 0; i < length; i++ ) {
+        result += characters.charAt(Math.floor(Math.random() * charactersLength));
+    }
+
+    return result;
+}

package/src/genericAuthContext.ts

@@ -8,12 +8,14 @@ import { UserPasswordChangeRes } from "./schemas/UserPasswordChangeRes";
 import { UserPasswordResetSettings} from "./schemas/UserPasswordResetSettings"
 import { UserPasswordResetStartRes } from "./schemas/UserPasswordResetStartRes"
 import { UserPasswordResetCompleteRes } from "./schemas/UserPasswordResetCompleteRes"
+import { GenericAuthsmsOptions } from "./genericAuthPluginOptions";
 
 export interface genericAuthContext{
     genericAuthPlugin : {
 
     
-        loginUser( repo : FlinkRepo<any, User>, auth : JwtAuthPlugin, username : string, password? : string, validatePasswordMethod? : { (password : string, hash : string, salt : string) : Promise<boolean>  } ) : Promise<UserLoginRes>,
+        loginUser( repo : FlinkRepo<any, User>, auth : JwtAuthPlugin, username : string, password? : string, validatePasswordMethod? : { (password : string, hash : string, salt : string) : Promise<boolean>  }, smsOptions? : GenericAuthsmsOptions ) : Promise<UserLoginRes>,
+        loginByToken(repo: FlinkRepo<any, User>, auth: JwtAuthPlugin, token : string, code : string,  jwtSecret : string) : Promise<UserLoginRes>,
         createUser( repo : FlinkRepo<any, User>, auth : JwtAuthPlugin, username : string, password : string, authentificationMethod : "password" | "sms",  roles : string[], profile : UserProfile, createPasswordHashAndSaltMethod? : { (password : string) : Promise<{ hash: string; salt: string;} | null>  }  ) : Promise<UserCreateRes>,
         changePassword( repo : FlinkRepo<any, User>, auth : JwtAuthPlugin, userId : string, newPassword : string, createPasswordHashAndSaltMethod? : { (password : string) : Promise<{ hash: string; salt: string;} | null>  } ) : Promise<UserPasswordChangeRes>,
         passwordResetStart( repo : FlinkRepo<any, User>, auth : JwtAuthPlugin, jwtSecret : string, username : string, numberOfDigits? : number, lifeTime? : string) : Promise<UserPasswordResetStartRes>,
@@ -23,6 +25,7 @@ export interface genericAuthContext{
         createPasswordHashAndSaltMethod? : { (password : string) : Promise<{ hash: string; salt: string;} | null>  },
         validatePasswordMethod? : { (password : string, hash : string, salt : string) : Promise<boolean>  },
         usernameFormat : RegExp      
+        smsOptions? : GenericAuthsmsOptions
     }
 
 }

package/src/genericAuthPluginOptions.ts

@@ -1,21 +1,32 @@
 import { UserPasswordResetSettings } from "./schemas/UserPasswordResetSettings";
-
+import { client as smsClient } from "@flink-app/sms-plugin";
 export interface GenericAuthPluginOptions {
-  repoName: string;
-  enableRoutes?: boolean;
-  enablePasswordReset?: boolean;
-  enablePushNotificationTokens?: boolean;
-  passwordResetSettings?: UserPasswordResetSettings;
-  enableUserCreation?: boolean;
-  enableProfileUpdate?: boolean;
-  enablePasswordUpdate?: boolean;
-  baseUrl?: string;
-  pluginId?: string;
-  createPasswordHashAndSaltMethod?: {
-    (password: string): Promise<{ hash: string; salt: string } | null>;
-  };
-  validatePasswordMethod?: {
-    (password: string, hash: string, salt: string): Promise<boolean>;
-  };
-  usernameFormat?: RegExp;
+    repoName: string;
+    enableRoutes?: boolean;
+    enablePasswordReset?: boolean;
+    enablePushNotificationTokens?: boolean;
+    passwordResetSettings?: UserPasswordResetSettings;
+    enableUserCreation?: boolean;
+    enableProfileUpdate?: boolean;
+    enablePasswordUpdate?: boolean;
+    baseUrl?: string;
+    pluginId?: string;
+    createPasswordHashAndSaltMethod?: {
+        (password: string): Promise<{ hash: string; salt: string } | null>;
+    };
+    validatePasswordMethod?: {
+        (password: string, hash: string, salt: string): Promise<boolean>;
+    };
+
+    usernameFormat?: RegExp;
+    sms?: GenericAuthsmsOptions;
+}
+
+export interface GenericAuthsmsOptions {
+    smsClient: smsClient;
+    smsFrom: string;
+    smsMessage: string;
+    jwtToken: string;
+    codeType: "numeric" | "alphanumeric";
+    codeLength: number;
 }

package/src/handlers/UserLogin.ts

@@ -11,12 +11,14 @@ const userLoginHandler: Handler<
 > = async ({ ctx, req, origin }) => {
   let pluginName = origin || "genericAuthPlugin";
   let repo = ctx.repos[(<any>ctx.plugins)[pluginName].repoName];
+  
   const loginRespons = await ctx.plugins.genericAuthPlugin.loginUser(
     repo,
     <JwtAuthPlugin>ctx.auth,
     req.body.username,
     req.body.password,
-    ctx.plugins.genericAuthPlugin.validatePasswordMethod
+    ctx.plugins.genericAuthPlugin.validatePasswordMethod,
+    (<any>ctx.plugins)[pluginName].smsOptions
   );
 
   if (loginRespons.status != "success") {

package/src/handlers/UserLoginByToken.ts

@@ -0,0 +1,39 @@
+import { FlinkContext, Handler, unauthorized } from "@flink-app/flink";
+import { JwtAuthPlugin } from "@flink-app/jwt-auth-plugin";
+import { genericAuthContext } from "../genericAuthContext";
+import { UserLoginByTokenReq } from "../schemas/UserLoginByTokenReq";
+import { UserLoginRes } from "../schemas/UserLoginRes";
+
+const userLoginHandler: Handler<
+  FlinkContext<genericAuthContext>,
+  UserLoginByTokenReq,
+  UserLoginRes
+> = async ({ ctx, req, origin }) => {
+  let pluginName = origin || "genericAuthPlugin";
+  let repo = ctx.repos[(<any>ctx.plugins)[pluginName].repoName];
+  
+  const loginRespons = await ctx.plugins.genericAuthPlugin.loginByToken(
+    repo,
+    <JwtAuthPlugin>ctx.auth,
+    req.body.token,
+    req.body.code,
+    (<any>ctx.plugins)[pluginName].smsOptions.jwtToken
+  );
+
+  if (loginRespons.status != "success") {
+    switch (loginRespons.status) {
+      case "failed":
+        return unauthorized(
+          "Invalid token or code",
+          loginRespons.status
+        );
+    }
+  }
+
+  return {
+    data: loginRespons,
+    status: 200,
+  };
+};
+
+export default userLoginHandler;

package/src/index.ts

@@ -5,6 +5,7 @@ import {
   changePassword,
   passwordResetComplete,
   passwordResetStart,
+  loginByToken
 } from "./coreFunctions";
 import { init } from "./init";
 import { GenericAuthPluginOptions } from "./genericAuthPluginOptions";
@@ -24,6 +25,7 @@ export const genericAuthPlugin = (
     init: (app) => init(app, options),
     ctx: {
       loginUser,
+      loginByToken,
       createUser,
       changePassword,
       passwordResetStart,
@@ -33,6 +35,7 @@ export const genericAuthPlugin = (
       createPasswordHashAndSaltMethod: options.createPasswordHashAndSaltMethod,
       validatePasswordMethod: options.validatePasswordMethod,
       usernameFormat: options.usernameFormat || /.{1,}$/,
+      smsOptions : options.sms
     },
   };
 };

package/src/init.ts

@@ -1,5 +1,6 @@
 import { FlinkApp, HttpMethod } from "@flink-app/flink";
 import * as userLoginHandler from "./handlers/UserLogin";
+import * as userLoginByTokenHandler from "./handlers/UserLoginByToken";
 import * as userCreateHandler from "./handlers/UserCreate";
 import * as getProfileHandler from "./handlers/UserProfileGet";
 import * as putUserProfileHandler from "./handlers/UserProfilePut";
@@ -25,6 +26,14 @@ export function init(app: FlinkApp<any>, options: GenericAuthPluginOptions) {
       docs: "Authenticates a user",
       origin: options.pluginId,
     });
+    if(options.sms){
+      app.addHandler(userLoginByTokenHandler, {
+        method: HttpMethod.post,
+        path: options.baseUrl + "/login-by-token",
+        docs: "Authenticates a user by token",
+        origin: options.pluginId,
+      });
+    }
     if (options.enableUserCreation) {
       app.addHandler(userCreateHandler, {
         method: HttpMethod.post,

package/src/schemas/UserCreateRes.ts

@@ -1,8 +1,8 @@
 export interface UserCreateRes {
-    status : "success" | "error" | "userExists" | "passwordError";
-    user? : {
-        _id : string;
-        username : string;
-        token : string;
-    }
-}
+    status: "success" | "error" | "userExists" | "passwordError";
+    user?: {
+        _id: string;
+        username: string;
+        token: string;
+    };
+}

package/src/schemas/UserLoginByTokenReq.ts

@@ -0,0 +1,4 @@
+export interface UserLoginByTokenReq {
+    token : string,
+    code : string
+}