@flink-app/generic-auth-plugin 0.2.0-beta.7 → 0.3.1

package/dist/src/handlers/UserToken.js

@@ -36,7 +36,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.__schemas = exports.__file = exports.__assumedHttpMethod = void 0;
+exports.__schemas = exports.__params = exports.__query = exports.__file = exports.__assumedHttpMethod = void 0;
 var flink_1 = require("@flink-app/flink");
 var getUserTokenHandler = function (_a) {
     var ctx = _a.ctx, req = _a.req, origin = _a.origin;
@@ -47,7 +47,7 @@ var getUserTokenHandler = function (_a) {
                 case 0:
                     pluginName = origin || "genericAuthPlugin";
                     repo = ctx.repos[ctx.plugins[pluginName].repoName];
-                    return [4 /*yield*/, repo.getBydId(req.user._id)];
+                    return [4 /*yield*/, repo.getById(req.user._id)];
                 case 1:
                     user = _b.sent();
                     if (user == null) {
@@ -65,5 +65,5 @@ var getUserTokenHandler = function (_a) {
     });
 };
 exports.default = getUserTokenHandler;
-exports.__assumedHttpMethod = "", exports.__file = "UserToken.ts";
+exports.__assumedHttpMethod = "", exports.__file = "UserToken.ts", exports.__query = [], exports.__params = [];
 exports.__schemas = { reqSchema: { "type": "object", "additionalProperties": false, "properties": { "token": { "type": "string" } }, "required": ["token"] }, resSchema: undefined };

package/dist/src/init.js

@@ -31,7 +31,9 @@ var postPasswordResetCompleteHandler = __importStar(require("./handlers/UserPass
 var postUserPushRegisterTokenHandler = __importStar(require("./handlers/UserPushRegisterToken"));
 var postUserRemoveTokenHandler = __importStar(require("./handlers/UserPushRemoveToken"));
 var getUserTokenHandler = __importStar(require("./handlers/UserToken"));
+var UserPasswordResetForm_1 = require("./handlers/UserPasswordResetForm");
 function init(app, options) {
+    var _a, _b;
     if (options.enableUserCreation == null)
         options.enableUserCreation = true;
     if (options.enableProfileUpdate == null)
@@ -100,6 +102,15 @@ function init(app, options) {
                 docs: "Completes a password reset for a user",
                 origin: options.pluginId,
             });
+            if ((_a = options.passwordResetSettings) === null || _a === void 0 ? void 0 : _a.enablePasswordResetForm) {
+                (_b = app.expressApp) === null || _b === void 0 ? void 0 : _b.get(options.baseUrl + "/password/reset/form", function (req, res) {
+                    var _a;
+                    return UserPasswordResetForm_1.handleUserPasswordResetForm(req, res, {
+                        templateFile: (_a = options.passwordResetSettings) === null || _a === void 0 ? void 0 : _a.passwordResetForm,
+                        completeUrl: options.baseUrl + "/password/reset/complete",
+                    });
+                });
+            }
         }
         if (options.enablePushNotificationTokens) {
             app.addHandler(postUserPushRegisterTokenHandler, {

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

@@ -9,4 +9,6 @@ export interface UserPasswordResetSettings {
         lifeTime: string;
         jwtSecret: string;
     };
+    enablePasswordResetForm?: boolean;
+    passwordResetForm?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flink-app/generic-auth-plugin",
-  "version": "0.2.0-beta.7",
+  "version": "0.3.1",
   "description": "Flink plugin that provides a generic user authentification solution.",
   "scripts": {
     "test": "echo \"Error: no test specified\"",
@@ -16,18 +16,18 @@
   "types": "dist/src/index.d.ts",
   "main": "dist/src/index.js",
   "dependencies": {
-    "@flink-app/email-plugin": "^0.2.0-beta.7",
-    "@flink-app/jwt-auth-plugin": "^0.2.0-beta.7",
-    "@flink-app/management-api-plugin": "^0.2.0-beta.7",
+    "@flink-app/email-plugin": "^0.3.0",
+    "@flink-app/jwt-auth-plugin": "^0.3.0",
+    "@flink-app/management-api-plugin": "^0.3.0",
     "handlebars": "^4.7.7",
     "jsonwebtoken": "^8.5.1"
   },
   "devDependencies": {
-    "@flink-app/flink": "^0.2.0-beta.7",
+    "@flink-app/flink": "^0.3.0",
     "@types/jsonwebtoken": "^8.5.2",
     "@types/node": "^15.6.2",
     "ts-node": "^9.1.1",
     "typescript": "^4.2.4"
   },
-  "gitHead": "f3f528687caad6f8738ccd53e797bba10fd3d987"
+  "gitHead": "95140d0eaa2c17a8f6214c44fe5dda057585af82"
 }

package/src/coreFunctions.ts

@@ -1,4 +1,3 @@
-
 import { FlinkRepo, FlinkAuthUser, log } from "@flink-app/flink";
 import { JwtAuthPlugin, jwtAuthPlugin } from "@flink-app/jwt-auth-plugin";
 
@@ -7,70 +6,78 @@ import { UserCreateRes } from "./schemas/UserCreateRes";
 import { UserLoginRes } from "./schemas/UserLoginRes";
 import { UserProfile } from "./schemas/UserProfile";
 import { UserPasswordChangeRes } from "./schemas/UserPasswordChangeRes";
-import { UserPasswordResetStartRes} from "./schemas/UserPasswordResetStartRes";
+import { UserPasswordResetStartRes } from "./schemas/UserPasswordResetStartRes";
 import { UserPasswordResetCompleteRes } from "./schemas/UserPasswordResetCompleteRes";
 
 import jsonwebtoken from "jsonwebtoken";
 
-
-
-export function getJtwTokenPlugin(secret : string, rolePermissions? : { [role: string]: string[]; }, passwordPolicy? : RegExp){
-    if(passwordPolicy == undefined){
+export function getJtwTokenPlugin(secret: string, rolePermissions?: { [role: string]: string[] }, passwordPolicy?: RegExp) {
+    if (passwordPolicy == undefined) {
         passwordPolicy = /.{1,}$/;
     }
-    if(rolePermissions == undefined){
-        rolePermissions = { }
+    if (rolePermissions == undefined) {
+        rolePermissions = {};
     }
-    if(rolePermissions["user"] == null){
+    if (rolePermissions["user"] == null) {
         rolePermissions["user"] = [];
     }
-    if(!rolePermissions["user"].includes("authenticated")) rolePermissions["user"].push("authenticated");
+    if (!rolePermissions["user"].includes("authenticated")) rolePermissions["user"].push("authenticated");
 
     return jwtAuthPlugin({
-        secret, 
-        getUser : (tokenData : any) => {
+        secret,
+        getUser: (tokenData: any) => {
             return new Promise<FlinkAuthUser>((res) => {
-            res({
-                username : tokenData.username,
-                _id : tokenData._id
-            })
-            })
+                res({
+                    username: tokenData.username,
+                    _id: tokenData._id,
+                });
+            });
         },
         passwordPolicy,
-        rolePermissions
-    }) 
+        rolePermissions,
+    });
 }
 
-export async function 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> {
-    
-    if(!roles.includes("user")) roles.push("user");
+export async function 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> {
+    if (!roles.includes("user")) roles.push("user");
 
-    const existingUser = await repo.getOne({ username : username.toLowerCase() } );
-    if(existingUser != null){
+    const existingUser = await repo.getOne({ username: username.toLowerCase() });
+    if (existingUser != null) {
         return {
-            status : "userExists"
-        }
+            status: "userExists",
+        };
     }
-    let userData : Omit<User, "_id"> = {
-        username,
+    let userData: Omit<User, "_id"> = {
+        username: username.toLowerCase(),
         roles,
         profile,
         authentificationMethod,
-        pushNotificationTokens : []
-    } 
+        pushNotificationTokens: [],
+    };
 
-    if(authentificationMethod == "password"){
+    if (authentificationMethod == "password") {
         let passwordAndSalt = null;
-        if(createPasswordHashAndSaltMethod != null){
+        if (createPasswordHashAndSaltMethod != null) {
             passwordAndSalt = await createPasswordHashAndSaltMethod(password);
-        }else{
+        } else {
             passwordAndSalt = await auth.createPasswordHashAndSalt(password);
         }
-            
-        if(passwordAndSalt == null){
+
+        if (passwordAndSalt == null) {
             return {
-                status : "passwordError"
-            }
+                status: "passwordError",
+            };
         }
         userData.password = passwordAndSalt.hash;
         userData.salt = passwordAndSalt.salt;
@@ -78,207 +85,215 @@ export async function createUser( repo : FlinkRepo<any, User>, auth : JwtAuthPlu
 
     const user = await repo.create(userData);
 
-    const token = await auth.createToken({ username : username.toLowerCase(), _id : user._id}, roles);
+    const token = await auth.createToken({ username: username.toLowerCase(), _id: user._id }, roles);
 
     return {
-        status : "success", 
-        user : {
-            "_id" : user._id,
-            "token" : token,
-            username : username.toLowerCase()
-        }
-    }
-   
-}  
+        status: "success",
+        user: {
+            _id: user._id,
+            token: token,
+            username: username.toLowerCase(),
+        },
+    };
+}
 
-export async function loginUser( repo : FlinkRepo<any, User>, auth : JwtAuthPlugin, username : string, password : string|undefined, validatePasswordMethod? : { (password : string, hash : string, salt : string) : Promise<boolean>  } ) : Promise<UserLoginRes> {
-    const user = await repo.getOne({ username : username.toLowerCase() } )
-    if(user == null){
-        return { status : "failed" };
+export async function loginUser(
+    repo: FlinkRepo<any, User>,
+    auth: JwtAuthPlugin,
+    username: string,
+    password: string | undefined,
+    validatePasswordMethod?: {
+        (password: string, hash: string, salt: string): Promise<boolean>;
+    }
+): Promise<UserLoginRes> {
+    const user = await repo.getOne({ username: username.toLowerCase() });
+    if (user == null) {
+        return { status: "failed" };
     }
-    
-    let valid : boolean = false;
 
-    if(user.authentificationMethod == "password"){
-        if(password == null) password = "";
-        
-        if(validatePasswordMethod!=null){
+    let valid: boolean = false;
+
+    if (user.authentificationMethod == "password") {
+        if (password == null) password = "";
+
+        if (validatePasswordMethod != null) {
             valid = await validatePasswordMethod(password, <string>user.password, <string>user.salt);
 
             //If not valid, try to use default auth
-            if(!valid){
-                try{
-                    valid = await auth.validatePassword(password, <string>user.password, <string>user.salt);        
-                }catch(ex){}
+            if (!valid) {
+                try {
+                    valid = await auth.validatePassword(password, <string>user.password, <string>user.salt);
+                } catch (ex) {}
             }
-        }else{
+        } else {
             valid = await auth.validatePassword(password, <string>user.password, <string>user.salt);
-
         }
-
     }
-    if(user.authentificationMethod == "sms"){
-        log.error("SMS login is not yet impleted.")
-        return { status : "failed" };
+    if (user.authentificationMethod == "sms") {
+        log.error("SMS login is not yet impleted.");
+        return { status: "failed" };
     }
 
-
-    if(valid){
-        const token = await auth.createToken({ username : username.toLowerCase(), _id : user._id}, user.roles);
+    if (valid) {
+        const token = await auth.createToken({ username: username.toLowerCase(), _id: user._id }, user.roles);
 
         return {
-            status : "success",
-            user : {
-                _id : user._id,
-                username : user.username,
+            status: "success",
+            user: {
+                _id: user._id,
+                username: user.username,
                 token,
-                profile : user.profile
-            }
-        }
-        
-    }else{
-        return { status : "failed" };
+                profile: user.profile,
+            },
+        };
+    } else {
+        return { status: "failed" };
     }
 }
 
-
-
-
-export async function changePassword( repo : FlinkRepo<any, User>, auth : JwtAuthPlugin, userId : string, newPassword : string, createPasswordHashAndSaltMethod? : { (password : string) : Promise<{ hash: string; salt: string;} | null>  } ) : Promise<UserPasswordChangeRes> {
-    const user = await repo.getBydId(userId);
-    if(user == null){
-        return { status : "failed" };
+export async function changePassword(
+    repo: FlinkRepo<any, User>,
+    auth: JwtAuthPlugin,
+    userId: string,
+    newPassword: string,
+    createPasswordHashAndSaltMethod?: {
+        (password: string): Promise<{ hash: string; salt: string } | null>;
     }
-    
-    if(user.authentificationMethod != "password"){
-        return { status : "failed"};
+): Promise<UserPasswordChangeRes> {
+    const user = await repo.getById(userId);
+    if (user == null) {
+        return { status: "failed" };
+    }
+
+    if (user.authentificationMethod != "password") {
+        return { status: "failed" };
     }
 
     let passwordAndSalt = null;
-    
-    if(createPasswordHashAndSaltMethod == null){
+
+    if (createPasswordHashAndSaltMethod == null) {
         passwordAndSalt = await auth.createPasswordHashAndSalt(newPassword);
-    }else{
-        passwordAndSalt = await createPasswordHashAndSaltMethod(newPassword)
+    } else {
+        passwordAndSalt = await createPasswordHashAndSaltMethod(newPassword);
     }
-    
-    if(passwordAndSalt == null){
+
+    if (passwordAndSalt == null) {
         return {
-            status : "passwordError"
-        }
+            status: "passwordError",
+        };
     }
 
-    await repo.updateOne(userId, { password : passwordAndSalt.hash, salt : passwordAndSalt.salt });
-
-    return { status : "success"}
-
-
-
+    await repo.updateOne(userId, {
+        password: passwordAndSalt.hash,
+        salt: passwordAndSalt.salt,
+    });
 
+    return { status: "success" };
 }
 
-
-
-
-
-export async function passwordResetStart( repo : FlinkRepo<any, User>, auth : JwtAuthPlugin, jwtSecret : string, username : string, numberOfDigits? : number, lifeTime? : string) : Promise<UserPasswordResetStartRes> {
-
-    const user = await repo.getOne({ username : username.toLowerCase() } )
-    if(user == null){
-        return { status : "userNotFound" };
+export async function passwordResetStart(
+    repo: FlinkRepo<any, User>,
+    auth: JwtAuthPlugin,
+    jwtSecret: string,
+    username: string,
+    numberOfDigits?: number,
+    lifeTime?: string
+): Promise<UserPasswordResetStartRes> {
+    const user = await repo.getOne({ username: username.toLowerCase() });
+    if (user == null) {
+        return { status: "userNotFound" };
     }
-    
-    if(user.authentificationMethod != "password"){
-        return { status : "userNotFound"};
+
+    if (user.authentificationMethod != "password") {
+        return { status: "userNotFound" };
     }
 
-    if(numberOfDigits == null) numberOfDigits = 6;
-    if(lifeTime == null) lifeTime = "1h"
+    if (numberOfDigits == null) numberOfDigits = 6;
+    if (lifeTime == null) lifeTime = "1h";
 
     const payload = {
-        "type" : "passwordReset",
-        "username" : username.toLocaleLowerCase(), 
-
-    }
-    const code = generate(numberOfDigits)
+        type: "passwordReset",
+        username: username.toLocaleLowerCase(),
+    };
+    const code = generate(numberOfDigits);
 
     const secret = jwtSecret + ":" + code;
 
-    const options : jsonwebtoken.SignOptions = {
-        expiresIn : lifeTime
-    }
-
-    const token = jsonwebtoken.sign(payload, secret, options )
-
-
-    return { status : "success", passwordResetToken : token, code, profile : user.profile }
-
-
+    const options: jsonwebtoken.SignOptions = {
+        expiresIn: lifeTime,
+    };
 
+    const token = jsonwebtoken.sign(payload, secret, options);
 
+    return {
+        status: "success",
+        passwordResetToken: token,
+        code,
+        profile: user.profile,
+    };
 }
 
-
-
-export async function passwordResetComplete( repo : FlinkRepo<any, User>, auth : JwtAuthPlugin, jwtSecret : string, passwordResetToken : string, code : string, newPassword : string, createPasswordHashAndSaltMethod? : { (password : string) : Promise<{ hash: string; salt: string;} | null>  }) : Promise<UserPasswordResetCompleteRes> {
-
-    let payload : { type : string, username : string} = { type : "", username : ""} ;
-    try{
+export async function passwordResetComplete(
+    repo: FlinkRepo<any, User>,
+    auth: JwtAuthPlugin,
+    jwtSecret: string,
+    passwordResetToken: string,
+    code: string,
+    newPassword: string,
+    createPasswordHashAndSaltMethod?: {
+        (password: string): Promise<{ hash: string; salt: string } | null>;
+    }
+): Promise<UserPasswordResetCompleteRes> {
+    let payload: { type: string; username: string } = { type: "", username: "" };
+    try {
         const secret = jwtSecret + ":" + code;
-        payload = <{ type : string, username : string} >jsonwebtoken.verify(passwordResetToken, secret );
-    }catch(ex){
-        return { status : "invalidCode"}
+        payload = <{ type: string; username: string }>jsonwebtoken.verify(passwordResetToken, secret);
+    } catch (ex) {
+        return { status: "invalidCode" };
     }
 
-    const user = await repo.getOne({ username : payload.username } )
-    if(user == null){
-        return { status : "userNotFound" };
-    }
-    
-    if(user.authentificationMethod != "password"){
-        return { status : "userNotFound"};
+    const user = await repo.getOne({ username: payload.username });
+    if (user == null) {
+        return { status: "userNotFound" };
     }
 
-
+    if (user.authentificationMethod != "password") {
+        return { status: "userNotFound" };
+    }
 
     let passwordAndSalt = null;
-    
-    if(createPasswordHashAndSaltMethod == null){
+
+    if (createPasswordHashAndSaltMethod == null) {
         passwordAndSalt = await auth.createPasswordHashAndSalt(newPassword);
-    }else{
+    } else {
         passwordAndSalt = await createPasswordHashAndSaltMethod(newPassword);
     }
-    
 
-    if(passwordAndSalt == null){
+    if (passwordAndSalt == null) {
         return {
-            status : "passwordError"
-        }
+            status: "passwordError",
+        };
     }
 
-    await repo.updateOne(user._id, { password : passwordAndSalt.hash, salt : passwordAndSalt.salt });
-
-    return { status : "success"}
-
-
-
+    await repo.updateOne(user._id, {
+        password: passwordAndSalt.hash,
+        salt: passwordAndSalt.salt,
+    });
 
+    return { status: "success" };
 }
 
+function generate(n: number): string {
+    var add = 1,
+        max = 12 - add;
 
-
-
-function generate(n : number) : string {
-    var add = 1, max = 12 - add;  
-
-    if ( n > max ) {
-            return generate(max) + generate(n - max);
+    if (n > max) {
+        return generate(max) + generate(n - max);
     }
 
-    max        = Math.pow(10, n+add);
-    var min    = max/10; 
-    var number = Math.floor( Math.random() * (max - min + 1) ) + min;
+    max = Math.pow(10, n + add);
+    var min = max / 10;
+    var number = Math.floor(Math.random() * (max - min + 1)) + min;
 
-    return ("" + number).substring(add); 
+    return ("" + number).substring(add);
 }
-

package/src/handlers/Management/GetUserByUserid.ts

@@ -1,25 +1,31 @@
-import { FlinkContext, Handler, HttpMethod, notFound, RouteProps } from "@flink-app/flink";
+import {
+  FlinkContext,
+  Handler,
+  HttpMethod,
+  notFound,
+  RouteProps,
+} from "@flink-app/flink";
 import { GetManagementUserByUseridReq } from "../../schemas/Management/GetUserByUseridReq";
 import { GetManagementUserByUseridRes } from "../../schemas/Management/GetUserByUseridRes";
 
-
-
-const GetManagementUserByUserid: Handler<FlinkContext, GetManagementUserByUseridReq, GetManagementUserByUseridRes> = async ({ ctx, req, origin }) => {
-
+const GetManagementUserByUserid: Handler<
+  FlinkContext,
+  GetManagementUserByUseridReq,
+  GetManagementUserByUseridRes
+> = async ({ ctx, req, origin }) => {
   let pluginName = origin || "genericAuthPlugin";
-  let repo = ctx.repos[ (<any>ctx.plugins)[pluginName].repoName ];
+  let repo = ctx.repos[(<any>ctx.plugins)[pluginName].repoName];
 
-  const user = await repo.getBydId(req.params.userid);
-  if(user == null){
+  const user = await repo.getById(req.params.userid);
+  if (user == null) {
     return notFound();
   }
 
   const { password, salt, ...u } = user;
 
-    return {
-      data: u,
-      status : 200
-    };
-
-}
-export default GetManagementUserByUserid;
+  return {
+    data: u,
+    status: 200,
+  };
+};
+export default GetManagementUserByUserid;

package/src/handlers/Management/PutUserPasswordByUserid.ts

@@ -11,7 +11,7 @@ const PutManagementUserPasswordByUserid: Handler<
   let pluginName = origin || "genericAuthPlugin";
   let repo = ctx.repos[(<any>ctx.plugins)[pluginName].repoName];
 
-  const user = await repo.getBydId(req.params.userid);
+  const user = await repo.getById(req.params.userid);
   if (user == null) {
     return notFound();
   }