Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/approov/quickstart-nodejs-koa-token-check

Quickstart Approov integration example for the NodeJS Koa framework.
https://github.com/approov/quickstart-nodejs-koa-token-check

api api-security approov approov-backend approov-backend-quicksart approov-integration approov-quickstart koa node nodejs security

Last synced: about 2 months ago
JSON representation

Quickstart Approov integration example for the NodeJS Koa framework.

Awesome Lists containing this project

README 

        
# Approov QuickStart - NodeJS Koa Token Check



[Approov](https://approov.io) is an API security solution used to verify that requests received by your backend services originate from trusted versions of your mobile apps.



This repo implements the Approov server-side request verification code for the NodeJS Koa framework, which performs the Approov token check before allowing valid traffic to be processed by the API endpoint.



## Approov Integration Quickstart



The quickstart was tested with the following Operating Systems:



* Ubuntu 20.04

* MacOS Big Sur

* Windows 10 WSL2 - Ubuntu 20.04



First, setup the [Approov CLI](https://approov.io/docs/latest/approov-installation/index.html#initializing-the-approov-cli).



Now, register the API domain for which Approov will issues tokens:



```bash

approov api -add api.example.com

```



> **NOTE:** By default a symmetric key (HS256) is used to sign the Approov token on a valid attestation of the mobile app for each API domain it's added with the Approov CLI, so that all APIs will share the same secret and the backend needs to take care to keep this secret secure.

>

> A more secure alternative is to use asymmetric keys (RS256 or others) that allows for a different keyset to be used on each API domain and for the Approov token to be verified with a public key that can only verify, but not sign, Approov tokens.

>

> To implement the asymmetric key you need to change from using the symmetric HS256 algorithm to an asymmetric algorithm, for example RS256, that requires you to first [add a new key](https://approov.io/docs/latest/approov-usage-documentation/#adding-a-new-key), and then specify it when [adding each API domain](https://approov.io/docs/latest/approov-usage-documentation/#keyset-key-api-addition). Please visit [Managing Key Sets](https://approov.io/docs/latest/approov-usage-documentation/#managing-key-sets) on the Approov documentation for more details.



Next, enable your Approov `admin` role with:



```bash

eval `approov role admin`

````



For the Windows powershell:



```bash

set APPROOV_ROLE=admin:___YOUR_APPROOV_ACCOUNT_NAME_HERE___

````



Now, get your Approov Secret with the [Approov CLI](https://approov.io/docs/latest/approov-installation/index.html#initializing-the-approov-cli):



```bash

approov secret -get base64

```



Next, add the [Approov secret](https://approov.io/docs/latest/approov-usage-documentation/#account-secret-key-export) to your project `.env` file:



```env

APPROOV_BASE64_SECRET=approov_base64_secret_here

```



Now, add to your `package.json` file the [JWT dependency](https://github.com/auth0/node-jsonwebtoken#readme):



```json

"jsonwebtoken": "^8.5.1"

```



Next, in your code require the [JWT dependency](https://github.com/auth0/node-jsonwebtoken#readme):



```javascript

const jwt = require('jsonwebtoken')

```



Now, read the Approov secret from the environment and put it into a constant:



```javascript

const dotenv = require('dotenv').config()

const approovBase64Secret = dotenv.parsed.APPROOV_BASE64_SECRET;

const approovSecret = Buffer.from(approovBase64Secret, 'base64')

```



Next, verify the Approov token:



```javascript

const verifyApproovToken = async (ctx, next) => {



  const approovToken = ctx.headers['approov-token']



  if (!approovToken) {

    // You may want to add some logging here.

    ctx.status = 401

    ctx.body = {}

    return

  }



  // Decode the token with strict verification of the signature (['HS256']) to

  // prevent against the `none` algorithm attack.

  await jwt.verify(approovToken, approovSecret, { algorithms: ['HS256'] }, function(err, decoded) {

    if (err) {

      // You may want to add some logging here.

      ctx.status = 401

      ctx.body = {}

      return

    }



    // The Approov token was successfully verified. We will add the claims to

    // the request object to allow further use of them during the request

    // processing.

    ctx.approovTokenClaims = decoded



    next()

  })

}

```



Finally, add the function as a middleware to protect all your API endpoints with the Approov token check:



```javascript

// @IMPORTANT: Always add the `verifyApproovToken` middleware function before

//             your endpoints declaration.

//

// Using `["/"]` protects all endpoints in your API. Example to protect only

// specific endpoints: `["/checkout", "/payments", "/etc"]`.

// When adding an endpoint `/example` you are also protecting their child

// endpoints, like `/example/content`, `/example/content/:id`, etc. .

router.use(["/"], verifyApproovToken)

```



Not enough details in the bare bones quickstart? No worries, check the [detailed quickstarts](QUICKSTARTS.md) that contain a more comprehensive set of instructions, including how to test the Approov integration.



## More Information



* [Approov Overview](OVERVIEW.md)

* [Detailed Quickstarts](QUICKSTARTS.md)

* [Examples](EXAMPLES.md)

* [Testing](TESTING.md)



### System Clock



In order to correctly check for the expiration times of the Approov tokens is very important that the backend server is synchronizing automatically the system clock over the network with an authoritative time source. In Linux this is usually done with a NTP server.



## Issues



If you find any issue while following our instructions then just report it [here](https://github.com/approov/quickstart-nodejs-koa-token-check/issues), with the steps to reproduce it, and we will sort it out and/or guide you to the correct path.



## Useful Links



If you wish to explore the Approov solution in more depth, then why not try one of the following links as a jumping off point:



* [Approov Free Trial](https://approov.io/signup)(no credit card needed)

* [Approov Get Started](https://approov.io/product/demo)

* [Approov QuickStarts](https://approov.io/docs/latest/approov-integration-examples/)

* [Approov Docs](https://approov.io/docs)

* [Approov Blog](https://approov.io/blog/)

* [Approov Resources](https://approov.io/resource/)

* [Approov Customer Stories](https://approov.io/customer)

* [Approov Support](https://approov.io/contact)

* [About Us](https://approov.io/company)

* [Contact Us](https://approov.io/contact)