Secure a Basic Node.js App with the Authorization and Trust Management Service (XSUAA)

Prepare the index.js file

To prevent a direct call to your application without authentication, it is necessary to add some code to your application. In our example, you use the Node.js passport authentication middleware and configure it with the XSUAA JWT strategy.

1. Go to the product-list/myapp folder.

2. Open the index.js file.

3. To use additional libraries, add the following lines of code below the line // secure the direct call to the application

   const passport = require('passport');
   const { JWTStrategy } = require('@sap/xssec');
   const xsenv = require('@sap/xsenv');
   
   // XSUAA Middleware
   passport.use(new JWTStrategy(xsenv.getServices({uaa:{tag:'xsuaa'}}).uaa));
   
   app.use(passport.initialize());
   app.use(passport.authenticate('JWT', { session: false }));
   

   This code prevents direct calls to the product list application without a valid JWT.

4. To secure the product list with authorization checks, replace the line app.get('/products', getProducts); in the index.js file with the following code:

   app.get('/products', checkReadScope, getProducts);
   
   // Scope check
   function checkReadScope(req, res, next) {
   	if (req.authInfo.checkLocalScope('read')) {
   		return next();
   	} else {
       	console.log('Missing the expected scope');
       	res.status(403).end('Forbidden');
   	}
   }
   

   The checkReadScope function ensures that only a user with the correct authorizations can look at the products.

5. Save the file.

Prepare the package.json file

Since there are now more modules used beside the express module, you have to add the relevant dependencies to your package.json file. In this case the dependencies for the modules passport, @sap/xsenv and @sap/xssec have to be added.

If you want to use SAP modules locally, you need to add the npm configuration:

npm config set @sap:registry https://npm.sap.com

1. Open the package.json file.

2. Add the following dependencies:

   "dependencies": {
     "express": "^4.17.1",
     "@sap/xsenv": "^3.1.0",
     "@sap/xssec": "^3.0.10",
     "passport": "^0.4.1"    
   }
   

3. Save the file.

To use the XSUAA service, a file named xs-security.json is necessary. The file can define properties of the XSUAA service instance as well as different roles and authorizations. In this example the file contains a role template and a role collection with a Product List Viewer role, that enables the user later to view the products.

1. Add a folder named security to your product-list folder.

2. Within the folder, create a file named xs-security.json.

3. Add the following content:

   {
   	"xsappname": "product-list",
   	"tenant-mode": "dedicated",
   	"scopes": [
   		{
   			"name": "$XSAPPNAME.read",
   			"description": "With this scope, USER can read products."
   		}
   	],
   
   	"role-templates": [
   		{
   			"name": "Viewer",
   			"description": "Role to get the list of products",
   			"scope-references": [
   				"$XSAPPNAME.read"
   			]
   		}
   	],
   	"role-collections": [
   		{
   			"name": "ProductListViewer",
   			"description": "Product List Viewer",
   			"role-template-references": [
   				"$XSAPPNAME.Viewer"
   			]
   		}
   	]
   }
   

   This creates a role collection with a role template, and a role with a reading scope, so a user with this role can view the products.

4. Save the file

To learn more about the xs-security.json file, check the links at the end of this tutorial.

The approuter will enable you to create a secure route to your application.

1. Add a folder named approuter to your product-list folder.

2. Within that folder create a file named package.json.

3. Add the following content:

   {
       "name": "approuter",
       "dependencies": {
           "@sap/approuter": "^9.0.2"
       },
       "scripts": {
           "start": "node node_modules/@sap/approuter/approuter.js"
       }
   }
   

4. Save the file.

5. In the same folder, create a file named xs-app.json.

6. Add the following content to that file:

   {
     "routes": [{
       "source": "^/products",
       "target": "/",
       "destination": "products-destination"
     }]
   }
   

   This will create a destination called products-destination. The destination is later referenced in the manifest.yml.

7. Save the file.

   To learn more about the xs-app.json file, check the links at the end of this tutorial.

For performance reasons it is better to put the images of the application into a static resources folder with the application router.

1. Navigate to the approuter folder.

2. Add a folder named resources.

3. Move the images folder from myapp/static/ into the approuter/resources folder.

By the end of these steps, your folder structure should look like this:

product-list
├── approuter
  ├──resources
    ├── images
      ├── HT-1000.jpg
      ├── HT-1010.jpg
      ├── HT-1030.jpg
  ├── package.json
  ├──  xs-app.json
├── myapp
    ├── lib
        ├── repository.js
        ├── products.json
    ├── static
        ├── index.html
    ├── index.js  
    ├── package.json
├── security
    ├── xs-security.json
├── manifest.yaml    

In the manifest file you have to define a hostname for your application and add a destination. The manifest file is used to bind the XSUAA service instance to your application.

The steps show incrementally what parameters and values have to be added. To avoid indentation errors, you can just copy the whole code at the end.

1. Navigate to the product-list folder.

2. Open the file manifest.yaml.

3. Give your application a specific host name with the parameter route. The route has to be unique in the whole Cloud Foundry landscape, so make sure to add a random part to the route, for example your initials and your day of birth, like product-list-ap25 and approuter-product-list-ap25. You also need the route to configure a destination later.

   applications:
   # Product List Application
   - name: product-list
     instances: 1
     memory: 128M
     routes:
       - route: product-list-ap25.cfapps.eu10.hana.ondemand.com
     path: myapp
     buildpacks:
       - nodejs_buildpack  
     timeout: 180
   

4. Add the binding for the XSUAA service to your application.

     ...
     services:
       - xsuaa-service-tutorial
   

5. Add the configuration data for the approuter:

   applications:
   ...
   
   # Application Router
   - name: approuter
     routes:
       - route: approuter-product-list-ap25.cfapps.eu10.hana.ondemand.com
     path: approuter
     buildpacks:
       - nodejs_buildpack
     memory: 128M
   

6. Add a destination to the approuter.

   # Application Router
   ...
     env:
       destinations: >
         [
           {"name":"products-destination",
            "url":"https://product-list-ap25.cfapps.eu10.hana.ondemand.com",
            "forwardAuthToken": true}
         ]
   

   The name parameter is the same as previously defined in the file xs-app.json. the url parameter is the result of the host name of your application and the region of your Cloud Foundry landscape (https://<hostname>.cfapps.<region>.hana.ondemand.com). The forwardAuthToken parameter set to true ensures that the approuter forwards the JWT token to the destination.

7. Add the bindings for the XSUAA service to the approuter.

   ...
     services:
       - xsuaa-service-tutorial
   

8. Save the file.

When you completed the steps, your manifest.yml file should look like this:

applications:
# Application
- name: product-list
  instances: 1
  memory: 128M
  routes:
    - route: product-list-ap25.cfapps.eu10.hana.ondemand.com
  path: myapp
  buildpacks:
    - nodejs_buildpack  
  timeout: 180
  services:
    - xsuaa-service-tutorial

# Application Router
- name: approuter
  routes:
    - route: approuter-product-list-ap25.cfapps.eu10.hana.ondemand.com
  path: approuter
  buildpacks:
    - nodejs_buildpack
  memory: 128M
  services:
    - xsuaa-service-tutorial
  env:
    destinations: >
      [
        {"name":"products-destination",
         "url":"https://product-list-ap25.cfapps.eu10.hana.ondemand.com",
         "forwardAuthToken": true}
      ]

Because your are calling the product list over the approuter with /products you need to make a small change within the index.html file.

1. Navigate to the product-list/myapp/static folder.

2. Replace line 24 in the index.html file with the following code.

   var productsUrl = "/products/products"; //  contains path mapping which is specified in xs-app.json
   

3. Save the file.

Before you can deploy your application, you need to create the service instance for the XSUAA.

1. Log in to your Cloud Foundry account with the Cloud Foundry CLI.

2. Navigate to the product-list folder.

3. Create the XSUAA service instance with the xs-security.json security descriptor file.

   cf create-service xsuaa application xsuaa-service-tutorial -c security/xs-security.json
   

4. Deploy the application.

   cf push