w-web-perm 1.0.7 → 1.0.8

package/docs/WWebPerm.html

@@ -64,7 +64,7 @@
 
     
 
-    <h4 class="name" id="WWebPerm"><span class="type-signature"></span>new WWebPerm<span class="signature">(WOrm, url, db, getUserByToken, verifyUser, opt<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Object}</span></h4>
+    <h4 class="name" id="WWebPerm"><span class="type-signature"></span>new WWebPerm<span class="signature">(WOrm, url, db, getUserByToken, verifyBrowserUser, verifyAppUser, opt<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Object}</span></h4>
 
     
 
@@ -80,7 +80,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="WWebPerm.mjs.html">WWebPerm.mjs</a>, <a href="WWebPerm.mjs.html#line115">line 115</a>
+        <a href="WWebPerm.mjs.html">WWebPerm.mjs</a>, <a href="WWebPerm.mjs.html#line128">line 128</a>
     </li></ul></dd>
     
 
@@ -127,7 +127,7 @@
 
     <h5 class="h5-examples">Example</h5>
     
-    <pre class="prettyprint"><code>import WOrm from 'w-orm-mongodb/src/WOrmMongodb.mjs' //自行選擇引用ORM, 使用Mongodb測試
    bCheckUser: false,
    getUserById: null,
    bExcludeWhenNotAdmin: false,
    serverPort: 11006,
    subfolder: '', //mperm
    webName: {
        'eng': 'Permission Service',
        'cht': '權限管理系統',
    },
    webDescription: {
        'eng': 'A web service package for user permissions and management targets.',
        'cht': 'A web service package for user permissions and management targets.',
    },
    webLogo: 'data:image/svg+xml;base64,...',
    // return {} //測試無法登入
    if (token === '{token-for-application}') { //提供外部應用系統作為存取使用者
        return {
            id: 'id-for-application',
            name: 'application',
            email: 'admin@example.com',
            isAdmin: 'y',
        }
    }
    if (token === 'sys') { //開發階段w-ui-loginout自動給予browser使用者(且位於localhost)的token為sys
        return {
            id: 'id-for-admin',
            name: 'tester',
            email: 'admin@example.com',
            isAdmin: 'y',
        }
    }
    console.log('invalid token', token)
    console.log('於生產環境時得加入SSO等驗證token機制')
    return {}
    console.log('於生產環境時得加入驗證user機制')
    return user.isAdmin === 'y' //測試僅系統管理者使用
    console.log(err)
+    <pre class="prettyprint"><code>import WOrm from 'w-orm-mongodb/src/WOrmMongodb.mjs' //自行選擇引用ORM, 使用Mongodb測試
    bCheckUser: false,
    getUserById: null,
    bExcludeWhenNotAdmin: false,
    serverPort: 11006,
    subfolder: '', //mperm
    urlRedirect: 'https://www.google.com/', //本機測試時得先編譯, 再瀏覽: http://localhost:11006/
    webName: {
        'eng': 'Permission Service',
        'cht': '權限管理系統',
    },
    webDescription: {
        'eng': 'A web service package for user permissions and management targets.',
        'cht': 'A web service package for user permissions and management targets.',
    },
    webLogo: 'data:image/svg+xml;base64,...',
    // return {} //測試無法登入
    if (token === '{token-for-application}') { //提供外部應用系統作為存取使用者
        return {
            id: 'id-for-application',
            name: 'application',
            email: 'application@example.com',
            isAdmin: 'y',
        }
    }
    if (token === 'sys') { //開發階段w-ui-loginout自動給予browser使用者(且位於localhost)的token為sys
        return {
            id: 'id-for-admin',
            name: 'tester',
            email: 'admin@example.com', //mappingBy為email, 開發階段時會使用email找到所建置之使用者資料
            isAdmin: 'y',
        }
    }
    console.log('invalid token', token)
    console.log('於生產環境時得加入SSO等驗證token機制')
    return {}
    console.log('verifyBrowserUser/user', user)
    // return false //測試無法登入
    console.log('於生產環境時得加入限制瀏覽器使用者身份機制')
    return user.isAdmin === 'y' //測試僅系統管理者使用
    console.log('verifyAppUser/user', user)
    // return false //測試無法登入
    console.log('於生產環境時得加入限制應用程式使用者身份機制')
    return user.isAdmin === 'y' //測試僅系統管理者使用
    console.log(err)
 
 
 
@@ -305,7 +305,7 @@
 
         <tr>
             
-                <td class="name"><code>verifyUser</code></td>
+                <td class="name"><code>verifyBrowserUser</code></td>
             
 
             <td class="type">
@@ -334,7 +334,43 @@
                 </td>
             
 
-            <td class="description last"><p>輸入處理函數，函數會傳入使用者資訊物件，通過此函數識別後回傳布林值，允許使用者回傳true，反之回傳false</p></td>
+            <td class="description last"><p>輸入驗證瀏覽使用者身份之處理函數，函數會傳入使用者資訊物件，通過此函數識別後回傳布林值，允許使用者回傳true，反之回傳false</p></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>verifyAppUser</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">function</span>
+
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+
+                
+
+                
+                </td>
+            
+
+            
+                <td class="default">
+                
+                </td>
+            
+
+            <td class="description last"><p>輸入驗證應用程序使用者身份之處理函數，函數會傳入使用者資訊物件，通過此函數識別後回傳布林值，允許使用者回傳true，反之回傳false</p></td>
         </tr>
 
     
@@ -889,7 +925,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu Nov 02 2023 22:57:24 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Fri Nov 03 2023 12:07:17 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/WWebPerm.mjs.html

@@ -79,7 +79,8 @@ import { getUserRules } from '../src/plugins/mShare.mjs'
  * @param {String} url 輸入資料庫連線字串，例如'mongodb://sername:password@$127.0.0.1:27017'
  * @param {String} db 輸入資料庫名稱字串
  * @param {Function} getUserByToken 輸入處理函數，函數會傳入使用者token，通過此函數處理後並回傳使用者資訊物件，並至少須提供'id'、'email'、'name'、'isAdmin'欄位，且'isAdmin'限輸入'y'或'n'，且輸入'y'時會複寫權限系統該使用者之'isAdmin'欄位值
- * @param {Function} verifyUser 輸入處理函數，函數會傳入使用者資訊物件，通過此函數識別後回傳布林值，允許使用者回傳true，反之回傳false
+ * @param {Function} verifyBrowserUser 輸入驗證瀏覽使用者身份之處理函數，函數會傳入使用者資訊物件，通過此函數識別後回傳布林值，允許使用者回傳true，反之回傳false
+ * @param {Function} verifyAppUser 輸入驗證應用程序使用者身份之處理函數，函數會傳入使用者資訊物件，通過此函數識別後回傳布林值，允許使用者回傳true，反之回傳false
  * @param {Object} [opt={}] 輸入設定物件，預設{}
  * @param {Integer} [opt.serverPort=11006] 輸入伺服器通訊port，預設11006
  * @param {Boolean} [opt.bCheckUser=false] 輸入是否檢查使用者資訊布林值，預設false
@@ -93,10 +94,12 @@ import { getUserRules } from '../src/plugins/mShare.mjs'
  * @param {String} [opt.mappingBy='email'] 輸入外部系統識別使用者token後所提供之資料物件，與權限系統之使用者資料物件，兩者間查找之對應欄位，可選'id'、'email'、'name'，預設'email'
  * @returns {Object} 回傳物件，其內server為hapi伺服器實體，wsrv為w-converhp的伺服器事件物件，wsds為w-serv-webdata的伺服器事件物件，可監聽error事件
  * @example
+ *
  * import WOrm from 'w-orm-mongodb/src/WOrmMongodb.mjs' //自行選擇引用ORM, 使用Mongodb測試
  * import WWebPerm from './server/WWebPerm.mjs'
  * import getSettings from './g.getSettings.mjs'
  *
+ *
  * //st
  * let st = getSettings()
  *
@@ -110,6 +113,7 @@ import { getUserRules } from '../src/plugins/mShare.mjs'
  *
  *     serverPort: 11006,
  *     subfolder: '', //mperm
+ *     urlRedirect: 'https://www.google.com/', //本機測試時得先編譯, 再瀏覽: http://localhost:11006/
  *
  *     webName: {
  *         'eng': 'Permission Service',
@@ -129,7 +133,7 @@ import { getUserRules } from '../src/plugins/mShare.mjs'
  *         return {
  *             id: 'id-for-application',
  *             name: 'application',
- *             email: 'admin@example.com',
+ *             email: 'application@example.com',
  *             isAdmin: 'y',
  *         }
  *     }
@@ -137,7 +141,7 @@ import { getUserRules } from '../src/plugins/mShare.mjs'
  *         return {
  *             id: 'id-for-admin',
  *             name: 'tester',
- *             email: 'admin@example.com',
+ *             email: 'admin@example.com', //mappingBy為email, 開發階段時會使用email找到所建置之使用者資料
  *             isAdmin: 'y',
  *         }
  *     }
@@ -146,20 +150,29 @@ import { getUserRules } from '../src/plugins/mShare.mjs'
  *     return {}
  * }
  *
- * let verifyUser = (user) => {
- *     console.log('於生產環境時得加入驗證user機制')
+ * let verifyBrowserUser = (user, caller) => {
+ *     console.log('verifyBrowserUser/user', user)
+ *     // return false //測試無法登入
+ *     console.log('於生產環境時得加入限制瀏覽器使用者身份機制')
+ *     return user.isAdmin === 'y' //測試僅系統管理者使用
+ * }
+ *
+ * let verifyAppUser = (user, caller) => {
+ *     console.log('verifyAppUser/user', user)
+ *     // return false //測試無法登入
+ *     console.log('於生產環境時得加入限制應用程式使用者身份機制')
  *     return user.isAdmin === 'y' //測試僅系統管理者使用
  * }
  *
  * //WWebPerm
- * let instWWebPerm = WWebPerm(WOrm, url, db, getUserByToken, verifyUser, opt)
+ * let instWWebPerm = WWebPerm(WOrm, url, db, getUserByToken, verifyBrowserUser, verifyAppUser, opt)
  *
  * instWWebPerm.on('error', (err) => {
  *     console.log(err)
  * })
  *
  */
-function WWebPerm(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
+function WWebPerm(WOrm, url, db, getUserByToken, verifyBrowserUser, verifyAppUser, opt = {}) {
     let instWServHapiServer = null
 
 
@@ -191,10 +204,17 @@ function WWebPerm(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
     }
 
 
-    //check verifyUser
-    if (!isfun(verifyUser)) {
-        console.log('invalid verifyUser', verifyUser)
-        throw new Error('invalid verifyUser')
+    //check verifyBrowserUser
+    if (!isfun(verifyBrowserUser)) {
+        console.log('invalid verifyBrowserUser', verifyBrowserUser)
+        throw new Error('invalid verifyBrowserUser')
+    }
+
+
+    //check verifyAppUser
+    if (!isfun(verifyAppUser)) {
+        console.log('invalid verifyAppUser', verifyAppUser)
+        throw new Error('invalid verifyAppUser')
     }
 
 
@@ -312,8 +332,8 @@ function WWebPerm(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
     }
 
 
-    //getTokenUserForSelf
-    let getTokenUserForSelf = async(token) => {
+    //getTokenUser
+    let getTokenUser = async(token) => {
 
         //userSelf
         let userSelf = null
@@ -394,8 +414,18 @@ function WWebPerm(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
         }
         // console.log('userFind(isAdmin)', userFind)
 
-        //verifyUser
-        let b = verifyUser(userFind)
+        return userFind
+    }
+
+
+    //getAndVerifyBrowserTokenUser
+    let getAndVerifyBrowserTokenUser = async (token, caller = '') => {
+
+        //getTokenUser
+        let userSelf = await getTokenUser(token)
+
+        //verifyBrowserUser
+        let b = verifyBrowserUser(userSelf, caller)
         if (ispm(b)) {
             b = await b
         }
@@ -403,12 +433,34 @@ function WWebPerm(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
         //check
         if (!b) {
             console.log('userSelf', userSelf)
-            console.log('userFind', userFind)
-            console.log('user does not have permission')
+            console.log(`user does not have permission`)
             return Promise.reject(`user does not have permission`)
         }
 
-        return userFind
+        return userSelf
+    }
+
+
+    //getAndVerifyAppTokenUser
+    let getAndVerifyAppTokenUser = async (token, caller = '') => {
+
+        //getTokenUser
+        let userSelf = await getTokenUser(token)
+
+        //verifyAppUser
+        let b = verifyAppUser(userSelf, caller)
+        if (ispm(b)) {
+            b = await b
+        }
+
+        //check
+        if (!b) {
+            console.log('userSelf', userSelf)
+            console.log(`user does not have permission`)
+            return Promise.reject(`user does not have permission`)
+        }
+
+        return userSelf
     }
 
 
@@ -636,14 +688,14 @@ function WWebPerm(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
                 // console.log('getUserByToken', req)
 
                 async function core() {
-                    //提供對象為browser使用者, 且認定權限系統須系統管理員才能使用, 須先檢測token是否為系統管理員, 確認後回傳該使用者(系統管理員)資訊物件
+                    //提供對象為browser使用者, 須先檢測token是否有效, 確認後回傳該使用者之資訊物件
 
                     //token
                     let token = get(req, 'query.token', '')
                     // console.log('token', token)
 
-                    //getGenUserByUserId
-                    let userSelf = await getTokenUserForSelf(token)
+                    //getAndVerifyBrowserTokenUser
+                    let userSelf = await getAndVerifyBrowserTokenUser(token)
                     // console.log('userSelf', userSelf)
 
                     //check
@@ -654,11 +706,6 @@ function WWebPerm(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
                         return Promise.reject(`token does not have permission`)
                     }
 
-                    // //check
-                    // if (get(userSelf, 'isAdmin') !== 'y') { //權限系統須系統管理員才能使用
-                    //     return Promise.reject(`user does not have permission`)
-                    // }
-
                     return userSelf
                 }
 
@@ -676,14 +723,14 @@ function WWebPerm(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
                 // console.log('getPerm', req)
 
                 async function core() {
-                    //提供對象為node與browser使用者, 須先檢測token是否有效, 再依照token取得使用者資訊物件, 再由其userId查詢回傳該使用者權限資訊物件
+                    //提供對象為node與browser使用者, node實際也為轉發之browser使用者, 須先檢測token是否有效, 再依照token取得使用者資訊物件, 再由其userId查詢回傳該使用者之權限資訊物件
 
                     //parseToken
                     let token = parseToken(req)
                     // console.log('token', token)
 
-                    //getGenUserByUserId
-                    let userLogin = await getTokenUserForSelf(token)
+                    //getAndVerifyBrowserTokenUser
+                    let userLogin = await getAndVerifyBrowserTokenUser(token)
                     // console.log('userLogin', userLogin)
 
                     //check
@@ -735,14 +782,14 @@ function WWebPerm(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
                 // console.log('getPermById', req)
 
                 async function core() {
-                    //提供對象為node使用者, 且認定權限系統須系統管理員才能使用, 須先檢測token是否為系統管理員, 再由query取得欲查詢的使用者userId, 再由其userId查詢回傳該使用者權限資訊物件
+                    //提供對象為node使用者, 須為系統管理者, 須先檢測token是否有效, 再由query取得欲查詢的使用者userId, 再由其userId查詢回傳該使用者權限資訊物件
 
                     //token
                     let token = get(req, 'query.token', '')
                     // console.log('token', token)
 
-                    //getGenUserByUserId
-                    let userSelf = await getTokenUserForSelf(token)
+                    //getAndVerifyAppTokenUser
+                    let userSelf = await getAndVerifyAppTokenUser(token, 'getPermById')
                     // console.log('userSelf', userSelf)
 
                     //check
@@ -753,11 +800,6 @@ function WWebPerm(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
                         return Promise.reject(`token does not have permission`)
                     }
 
-                    // //check
-                    // if (get(userSelf, 'isAdmin') !== 'y') { //權限系統須系統管理員才能使用
-                    //     return Promise.reject(`user does not have permission`)
-                    // }
-
                     //userId
                     let userId = get(req, 'query.userId', '')
                     // console.log('userId', userId)
@@ -792,12 +834,13 @@ function WWebPerm(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
                 // console.log('payload', req.payload)
 
                 async function core() {
+                    //提供對象為node使用者, 須為系統管理者, 須先檢測token是否有效, 再進行數據變更
 
                     //token
                     let token = get(req, 'query.token', '')
 
-                    //getTokenUserForSelf
-                    let user = await getTokenUserForSelf(token)
+                    //getAndVerifyAppTokenUser
+                    let user = await getAndVerifyAppTokenUser(token, 'syncAndReplaceUsers')
 
                     //check
                     if (!iseobj(user)) {
@@ -831,12 +874,13 @@ function WWebPerm(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
                 // console.log('payload', req.payload)
 
                 async function core() {
+                    //提供對象為node使用者, 須為系統管理者, 須先檢測token是否有效, 再進行數據變更
 
                     //token
                     let token = get(req, 'query.token', '')
 
-                    //getTokenUserForSelf
-                    let user = await getTokenUserForSelf(token)
+                    //getAndVerifyAppTokenUser
+                    let user = await getAndVerifyAppTokenUser(token, 'syncAndReplaceTargets')
 
                     //check
                     if (!iseobj(user)) {
@@ -870,12 +914,13 @@ function WWebPerm(WOrm, url, db, getUserByToken, verifyUser, opt = {}) {
                 // console.log('payload', req.payload)
 
                 async function core() {
+                    //提供對象為node使用者, 須為系統管理者, 須先檢測token是否有效, 再進行數據變更
 
                     //token
                     let token = get(req, 'query.token', '')
 
-                    //getTokenUserForSelf
-                    let user = await getTokenUserForSelf(token)
+                    //getAndVerifyAppTokenUser
+                    let user = await getAndVerifyAppTokenUser(token, 'syncAndReplaceRuleGroups')
 
                     //check
                     if (!iseobj(user)) {
@@ -958,7 +1003,7 @@ export default WWebPerm
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu Nov 02 2023 22:57:24 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Fri Nov 03 2023 12:07:17 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/index.html

@@ -71,7 +71,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu Nov 02 2023 22:57:24 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Fri Nov 03 2023 12:07:17 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "w-web-perm",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "main": "dist/w-web-perm.umd.js",
   "dependencies": {
     "@mdi/js": "^7.2.96",
@@ -12,7 +12,7 @@
     "w-data-collector": "^1.0.19",
     "w-serv-hapi": "^1.0.11",
     "w-serv-orm": "^1.0.7",
-    "w-ui-loginout": "^1.0.4",
+    "w-ui-loginout": "^1.0.5",
     "wsemi": "^1.7.38"
   },
   "devDependencies": {