Framework fundementals - OCLC-Developer-Network/devconnect2018-idm GitHub Wiki

Configuration

1. In project root create file prod_config.yml
2. Edit prod_config.yml so it contains a set of key value pairs with:
   • wskey key
   • wskey secret
   • principalID
   • principalIDNS
   • institution registry ID

wskey: test
secret: secret
principalID: id 
principalIDNS: namespace
institution: 128807

Creating the Application Entry point

1. Create a file called server.js
2. Open server.js
3. Load dependencies

"use strict";
const express = require('express');
const bodyParser = require('body-parser');
const nodeauth = require("nodeauth");

const User = require("./user.js")
const UserError = require("./UserError.js")

4. Configure the application
   1. use ejs to render html templates
   2. set directory where views are stored to views

app.engine('html', require('ejs').renderFile);
app.set('view engine', 'html');
app.set('views', 'views'); 
 
app.use(bodyParser.urlencoded({ extended: true }));
app.use(express.static('public'));

module.exports = app;

Create code to load configuration information

1. In src folder create a file called config.js

2. Open config.js

   1. Create a function that loads the configuration data file as a string based on the environment

   "use strict";
   const fs = require('fs');
   
   module.exports = function get_config(environment) {
       let config = fs.readFileSync(require('path').resolve(__dirname, '../' + environment + '_config.yml')).toString();
       return config;
   };        
   

Create local configuration for running application

1. In project root create a file called local.js
2. Open local.js
   1. Require yaml parsing library
   2. Require src/config.js
   3. Set the environment
   4. Load the configuration
   5. Require src/server.js
   6. Tell application what port to run on
   7. Log what application is doing

const yaml = require('js-yaml');
const get_config = require("./src/config.js");
let environment = 'prod';
global.config = yaml.load(get_config(environment));
let app = require('./src/server.js');
let port = process.env.PORT || 8000;

// Server
app.listen(port, () => {
    console.log(`Listening on: http://localhost:${port}`);
});
        

Add script for starting app to package.json

1. Open package.json
2. In scripts section add

"start": "nodemon local.js",

Application Authentication

Authentication happens repeatedly in our application so we want to create a reusable function to handle Authentication when we need it. To do this we're using something called a "Middleware". The idea behind middleware is to allow us to intercept any request and tell the application to do something before and/or application request. In this case we're the application that anytime this function is called it should perform authentication BEFORE the client request.

1. Open server.js
2. Add authentication setup
   1. instantiate wskey object with appropriate "options"

const options = {
        services: ["SCIM:read_self", "refresh_token"],
        redirectUri: "http://localhost:8000/loggedIn"
    };

const wskey = new nodeauth.Wskey(config['wskey'], config['secret'], options);

3. Create a function that retrieve an Access token
   1. Check for an error code in the query paramters
      • if present, render the error page template
   2. Check for an existing valid Access Token
      • if present go on your way
   3. Check for valid Refresh Token
      • if present, use it to get a valid Access Token
   4. Check for Authorization code
      1. if present, use it to get a valid Access Token
      • if request succeed, set the Access token as an app variable and go on your way
      • if request fails, render error page template
   5. If none of the above, redirect the user login

    if (req.query['error']){
        res.render('display-error', {error: req.query['error'], error_message: req.query['error_description'], error_detail: ""});
    } else if (app.get('accessToken') && app.get('accessToken').getAccessTokenString() && !app.get('accessToken').isExpired()){
        next()
    } else if (app.get('accessToken') && !app.get('accessToken').refreshToken.isExpired()) {    
        app.get('accessToken').refresh();
        next();
    } else if (req.query['code']) { 
        // request an Access Token
        wskey.getAccessTokenWithAuthCode(req.query['code'], config['institution'], config['institution'])
            .then(function (accessToken) {
                app.set('accessToken', accessToken);
                //redirect to the state parameter
                let state = decodeURIComponent(req.query['state']);
                res.redirect(state);
            })
            .catch(function (err) {
                //catch the error
                let error = new UserError(err);
                res.render('display-error', {error: error.getCode(), error_message: error.getMessage(), error_detail: error.getDetail()});
            })
    }else { 
        // redirect to login + state parameter
        res.redirect(wskey.getLoginURL(config['institution'], config['institution']) + "&state=" + encodeURIComponent(req.originalUrl));
    }  

4. Add application level middleware which performs authentication everywhere using getAccessToken function.

app.use(function (req, res, next) {
    getAccessToken(req, res, next);
});