@sassoftware/viya-serverjs 0.1.1 → 0.2.0

package/src/plugins/SASauth.js

@@ -0,0 +1,79 @@
+/*
+ *  ------------------------------------------------------------------------------------
+ *  * Copyright (c) SAS Institute Inc.
+ *  *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  * you may not use this file except in compliance with the License.
+ *  * You may obtain a copy of the License at
+ *  *
+ *  * http://www.apache.org/licenses/LICENSE-2.0
+ *  *
+ *  *  Unless required by applicable law or agreed to in writing, software
+ *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  * See the License for the specific language governing permissions and
+ *  limitations under the License.
+ * ----------------------------------------------------------------------------------------
+ *
+ */
+
+
+let bell = require('@hapi/bell');
+let uuid = require('uuid');  
+let debug = require('debug')('sasauth');
+
+exports.plugin = {
+    name    : 'SASauth',
+    version : '1.0.0',
+    register: iSASauth
+};
+
+async function iSASauth (server, options) {
+    debug('in iSASauth');
+    debug('options', options);
+    let bellAuthOptions;
+    let provider;
+    // test for k8s deployment
+    let host = options.host + '/SASLogon';
+    
+
+    if (options.ns != null) {
+        host = `https://sas-logon-app.${options.ns}.svc.cluster.local`;
+    } else if (options.nsHost != null) {
+        host = options.nsHost;
+    }
+    // ...
+    debug(host);
+    provider = {
+        name         : 'sas',
+        protocol     : 'oauth2',
+        useParamsAuth: false,
+        auth         : host + '/oauth/authorize',
+        token        : host + '/oauth/token',
+
+        profileMethod: 'get',
+        
+        profile: async function (credentials, params, get) {  
+                     
+            server.log('SASAuth profile', credentials);
+            debug('credentials', credentials);
+        }
+       
+        
+    };
+    
+    bellAuthOptions = {
+        provider    : provider,
+        password    : uuid.v4(),
+        clientId    : options.clientId,
+        clientSecret: options.clientSecret,
+        //   isSameSite  : options.isSameSite,
+        isSecure    : options.isSecure
+    };
+    // console.log('SASAuth options', bellAuthOptions);
+    debug('belloptions', bellAuthOptions);
+    server.log('SASAuth',bellAuthOptions);
+    await server.register(bell);
+    server.auth.strategy('sas', 'bell', bellAuthOptions);
+    
+    }
+    

package/src/plugins/appCookie.js

@@ -0,0 +1,49 @@
+
+let uuid = require('uuid');
+let debug = require('debug')('cookie');
+
+module.exports = async function appCookie (server, options){
+
+    await server.register(require('@hapi/cookie'));
+    
+    debug('in appCookie');
+    debug(options.redirectTo);
+    let cookieOptions = {
+        cookie: {
+            name      : 'cookie',
+            password  : uuid.v4(),
+            isSecure  : options.isSecure,
+            isSameSite: options.isSameSite
+        },
+        redirectTo  : options.redirectTo,
+        appendNext  : {name: 'next'},
+        validateFunc: async (req, session) => {
+            server.log('Cookie validateFunc', `path - ${req.path}`);
+            
+            if (session == null) {
+                console.log('session is null');
+                return {valid: false};
+            }
+            let credentials = null;
+            let sid;
+            if (Array.isArray(session) === true && session.length > 0) {
+                sid = session[0].sid;
+            } else {
+                sid = session.sid;
+            }
+            if (sid != null) {
+                credentials = await req.server.app.cache.get(sid);
+             }
+             
+            if (credentials == null) {
+                return {valid: false};
+            }
+            server.log('Cookie validateFunc', sid);
+            return {valid: true, credentials: credentials};
+        }
+    };
+    // console.log('cookie options', cookieOptions);
+    server.log('Cookie Options',cookieOptions);
+    server.auth.strategy('session', 'cookie', cookieOptions);
+
+};

package/src/plugins/setContext.js

@@ -0,0 +1,34 @@
+/*
+ * ------------------------------------------------------------------------------------
+ *   Copyright (c) SAS Institute Inc.
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ * ---------------------------------------------------------------------------------------
+ *
+ */
+
+
+async function setContext (req,h){
+   let credentials = req.auth.credentials;
+   
+   let context = {
+        path   : req.path,
+        params : req.params,
+        query  : req.query,
+        payload: req.payload,
+        queryOrig: (credentials != null) ? credentials.query : {},
+        token  : (credentials != null) ? `bearer ${credentials.token}` : null,
+        host   : process.env.VIYA_SERVER
+        };
+    return context;
+}
+export default setContext;

package/src/plugins/setDefaultRoutes.js

@@ -0,0 +1,262 @@
+/*
+ *  ------------------------------------------------------------------------------------
+ *  * Copyright (c) SAS Institute Inc.
+ *  *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  * you may not use this file except in compliance with the License.
+ *  * You may obtain a copy of the License at
+ *  *
+ *  * http://www.apache.org/licenses/LICENSE-2.0
+ *  *
+ *  *  Unless required by applicable law or agreed to in writing, software
+ *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  * See the License for the specific language governing permissions and
+ *  limitations under the License.
+ * ----------------------------------------------------------------------------------------
+ *
+ */
+
+import {
+  getApp,
+  getApp2,
+  appCallback,
+  favicon,
+  keepAlive,
+  keepAlive2,
+  logout,
+  logon,
+  setupUserRoutes,
+  reactDev,
+  proxyMapUri,
+} from "../handlers";
+let debug = require("debug")("routes");
+module.exports = function setDefaultRoutes(server, options) {
+  debug("setDefaultRoutes");
+  let appName = "/" + options.appName;
+  let authDefault = false;
+  let authLogon = false;
+  if (options.authFlow === "server") {
+    authDefault =
+      options.serverMode === "app"
+        ? false
+        : {
+            strategies: ["token", "session"],
+            mode: "required",
+          };
+
+    authLogon = {
+      mode: "required",
+      strategy: "sas",
+    };
+  }
+  let getAppb = getApp.bind(
+    null,
+    process.env.USETOKEN === "YES" ? options : null
+  );
+
+  console.log("Default strategy", authDefault);
+  console.log("Logon strategy", authLogon);
+  options.authDefault = authDefault;
+  options.authLogon = authLogon;
+  
+  debug(options.userRouteTable);
+  let uTable =
+    options.userRouteTable !== null
+      ? setupUserRoutes(options.userRouteTable, options)
+      : null;
+  
+  let defaultTable = [
+    {
+      method: ["GET"],
+      path: `/health`,
+      options: {
+        auth: false,
+        handler: async (req, h) => {
+          return h.response({ x: 1 }).code(200);
+        },
+      },
+    },
+
+    {
+      method: ["GET"],
+      path: `${appName}/logon`,
+      options: {
+        auth: (options.authFlow === "server") ? 
+        { mode: "try",  strategy: "sas" } : null,
+        //https://futurestud.io/tutorials/hapi-redirect-to-previous-page-after-login
+        // set auth to null on all protected routes
+        plugins: {
+          "hapi-auth-cookie": { redirectTo: false },
+        },
+        handler: logon,
+      },
+    },
+    {
+      method: ["GET"],
+      path: `${appName}`,
+     
+      options: {
+        auth: (process.env.USELOGON === 'YES') ? null : options.serverMode === "app" ? authLogon : authDefault,
+        handler: getAppb,
+      },
+    },
+
+    {
+      method: ["GET"],
+      path: `${appName}/api`,
+      options: {
+        auth: authDefault,
+        handler: async (req, h) => {
+          return h.redirect(`${appName}/documentation`);
+        },
+      },
+    },
+    {
+      method: ["GET"],
+      path: `/develop`,
+      options: {
+        auth: false,
+        cors: true,
+        handler: reactDev,
+      },
+    },
+
+    {
+      method: ["GET"],
+      path: `${appName}/callback`,
+      options: {
+        auth: authDefault,
+        handler: appCallback,
+      },
+    },
+    {
+      method: ["GET"],
+      path: `${appName}/logout`,
+      options: {
+        auth: authDefault,
+        handler: logout,
+      },
+    },
+    {
+      method: ["GET", "POST"],
+      path: `${appName}/keepAlive`,
+
+      options: {
+        auth: authDefault,
+        handler: keepAlive,
+      },
+    },
+    {
+      method: ["GET"],
+      path: `${appName}/appenv`,
+      options: {
+        auth: /*authDefault*/ false,
+        handler: (req, h) => {
+          let allAppEnv = options.allAppEnv;
+          if (options.userInfo != null) {
+            let uappenv = options.userInfo("APPENV", options);
+            if (uappenv != null) {
+              allAppEnv.APPENV = { ...allAppEnv.APPENV, ...uappenv };
+            }
+          }
+          allAppEnv.credentials = options.credentials;
+
+          let s =
+            `let LOGONPAYLOAD = ${JSON.stringify(allAppEnv.LOGONPAYLOAD)};` +
+            `let APPENV = ${JSON.stringify(allAppEnv.APPENV)};`;
+          if (process.env.SHOWENV != null) {
+            console.log(options.allAppEnv);
+            console.log(s);
+          }
+          debug(s);
+          return s;
+        },
+      },
+    },
+    {
+      method: ["GET"],
+      path: `/appenv`,
+      options: {
+        auth: /*authDefault*/ false,
+        handler: (req, h) => {
+          let allAppEnv = options.allAppEnv;
+          if (options.userInfo != null) {
+            let uappenv = options.userInfo("APPENV", options);
+            if (uappenv != null) {
+              allAppEnv.APPENV = { ...allAppEnv.APPENV, ...uappenv };
+            }
+          }
+          allAppEnv.credentials = options.credentials;
+
+          let s =
+            `let LOGONPAYLOAD = ${JSON.stringify(allAppEnv.LOGONPAYLOAD)};` +
+            `let APPENV = ${JSON.stringify(allAppEnv.APPENV)};`;
+          if (process.env.SHOWENV != null) {
+            console.log(options.allAppEnv);
+            console.log(s);
+          }
+          debug(s)
+          return s;
+        },
+      },
+    },
+		
+    {
+      method: ["GET"],
+      path: `${appName}/{param*}`,
+
+      options: {
+        auth: authDefault,
+        handler: getApp2,
+      },
+    },
+		
+    {
+      method: ["GET"],
+      path: `/{param*}`,
+
+      options: {
+        auth: authDefault,
+        handler: getApp2,
+      },
+    },
+    {
+      method: ["GET"],
+      path: `/favicon.ico`,
+      options: {
+        auth: false,
+        handler: favicon,
+      },
+    },
+    {
+      method: ["GET", "POST"],
+      path: `${appName}/keepAlive2`,
+      options: {
+        auth: authDefault,
+        handler: keepAlive2,
+      },
+    },
+  ];
+
+  if (process.env.PROXYSERVER != null) {
+    let pr = {
+      method: ["GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS"],
+      path: `${appName}/proxy/{param*}`,
+      options: {
+        handler: {
+          proxy: {
+            mapUri: proxyMapUri,
+            xforward: true,
+            passThrough: true,
+          },
+        },
+      },
+    };
+    console.log(pr);
+    defaultTable.push(pr);
+  }
+  console.log(uTable);
+  let routeTables =
+    uTable !== null ? defaultTable.concat(uTable) : defaultTable;
+  server.route(routeTables);
+};

package/src/plugins/setupAuth.js

@@ -0,0 +1,48 @@
+/*
+ *  ------------------------------------------------------------------------------------
+ *  * Copyright (c) SAS Institute Inc.
+ *  *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  * you may not use this file except in compliance with the License.
+ *  * You may obtain a copy of the License at
+ *  *
+ *  * http://www.apache.org/licenses/LICENSE-2.0
+ *  *
+ *  *  Unless required by applicable law or agreed to in writing, software
+ *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  * See the License for the specific language governing permissions and
+ *  limitations under the License.
+ * ----------------------------------------------------------------------------------------
+ *
+ */
+
+let SASauth          = require('./SASauth');
+let appCookie        = require('./appCookie');
+let token            = require('./token');
+let setDefaultRoutes = require('./setDefaultRoutes');
+
+/** Notes:
+ * If api then register sasAuth and token - no cookies
+ * If app, then register sasAuth and cookie(session) but no token 
+ */
+async function setupAuth (server, options){
+	
+	if (options.authFlow === 'server') {
+		await server.register({plugin: SASauth,   options: options});
+		// await server.register({plugin: appCookie, options: options});
+		await appCookie(server,options);
+
+		let def = 'session';
+		if (options.serverMode === 'api') {
+			await server.register({ plugin: token });
+			def = 'token';
+		}
+		server.log('***********************Default auth', def);
+		server.auth.default(def);
+		// console.log(server.registerations);
+	}
+	setDefaultRoutes(server, options);
+	return true;
+};
+
+export default setupAuth;

package/src/plugins/setupUserRoutes.js

@@ -0,0 +1,48 @@
+/*
+ * ------------------------------------------------------------------------------------
+ *   Copyright (c) SAS Institute Inc.
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ * ---------------------------------------------------------------------------------------
+ *
+ */
+import setContext from './setContext';
+
+function setupUserRoutes (u, options) {
+    if (u == null) {
+        return [];
+    }
+    
+    let ux = (typeof u === 'function') ? u() : u;
+    let routes = ux.map(rx => {
+        //let rx = {...r};
+        /* change it to options */
+        if (rx.config != null) {
+            rx.options = {...rx.config};
+            delete rx.config;
+        }
+        if (rx.options.pre == null) {
+          rx.options.pre = [{method: setContext, assign: 'context'}];
+        } else{
+          rx.options.pre.push([{method: setContext, assign: 'context'}]);
+        }
+        if (rx.options.auth === true) {
+            rx.options.auth = options.authDefault;   
+        } else if (rx.options.auth === 'logon') {
+            rx.options.auth = options.authLogon;
+        } 
+       
+        return rx;
+    });
+    return routes;
+}
+export default setupUserRoutes;

package/src/plugins/token.js

@@ -0,0 +1,10 @@
+exports.plugin = {
+    name    : 'token',
+    version : '1.0.0',
+    register: itoken
+};
+
+async function itoken (server){
+    await server.auth.scheme('SAStoken',require('../schemes/SASTokenScheme'));
+    server.auth.strategy('token', 'SAStoken');
+}

package/src/schemes/SASTokenScheme.js

@@ -0,0 +1,43 @@
+/*
+ * ------------------------------------------------------------------------------------
+ *   Copyright (c) SAS Institute Inc.
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ * ---------------------------------------------------------------------------------------
+ *
+ */
+// lean code to handle of incoming tokens if present
+// designed to used with appCookie and SASauth
+
+const Boom = require('@hapi/boom');
+
+module.exports = function SASTokenScheme (server, options) {
+ 
+    const scheme = {
+        authenticate: async function (request, h) {
+            const authorization = request.headers.authorization;
+            server.log('SASToken', authorization);
+        
+            if (!authorization) {
+               throw Boom.unauthorized(null, 'session');
+            }
+            const [tokenType, token] = authorization.split(' ');
+            let credentials = {
+                token    : token,
+                tokenType: tokenType
+            };
+            return h.authenticated({credentials: credentials});
+        }
+    };
+
+    return scheme;
+};

package/src/visionIndex.html

@@ -0,0 +1,24 @@
+<html>
+    <body>
+        <div>
+            <h1 style="background-color:blue;">{{title}}</h1>
+            <div style="border-style:solid; border-width: 2px;"><pre>{{message}}<pre></pre></div>
+        </div>
+    
+         <h2>Hints for Logon Error - Contact your administrator</h2>
+      
+            <ul> 
+                <li>SAMESITE setting is not correct for your environment (contact your administrator)</li>
+                <li>Presence of self-signed certificates - might have to set NODE_TLS_REJECT_UNAUTHORIZED=0 in the env file</li>
+                <li>You might have to clear the cookies for your Viya Server</li>
+                <li>You might have to clear the cookies set by this app server</li>
+            </ul>
+        
+            <h2>404</h2>
+            <ul>
+                <li> Make sure the proper appname is used in script tags for /appenv and /user</li>
+                <li> Make sure you are starting the application at the proper url</li>
+            </ul>
+        
+    </body>
+</html>

package/start.sh

@@ -0,0 +1,15 @@
+#
+# Azure wants to prefix the app env 
+# Use this to set the env that this server expects
+
+# https://docs.microsoft.com/en-us/azure/app-service/reference-app-settings?tabs=kudu%2Cdotnet
+env | grep APPSETTING_
+
+if [[ ! -z "$APPSETTING_VIYA_SERVER" ]];
+then 
+    export VIYA_SERVER=$APPSETTING_VIYA_SERVER
+    echo VIYA SERVER= $VIYA_SERVER
+else 
+    echo "No custom application overrides"
+fi
+node server.js