Approov 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 in NodeJS (framework agnostic), which performs the verification check before allowing valid traffic to be processed by the API endpoint.
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.
Now, register the API domain for which Approov will issues tokens:
approov api -add api.example.comNOTE: 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, and then specify it when adding each API domain. Please visit Managing Key Sets on the Approov documentation for more details.
Next, enable your Approov admin role with:
eval `approov role admin`For the Windows powershell:
set APPROOV_ROLE=admin:___YOUR_APPROOV_ACCOUNT_NAME_HERE___Now, get your Approov Secret with the Approov CLI:
approov secret -get base64Next, add the Approov secret to your project .env file:
APPROOV_BASE64_SECRET=approov_base64_secret_hereNow, add to your package.json file the JWT dependency:
"jsonwebtoken": "^8.5.1"Next, in your code require the JWT dependency:
const jwt = require('jsonwebtoken')Now, grab the Approov secret into a constant:
const dotenv = require('dotenv').config()
const approovBase64Secret = dotenv.parsed.APPROOV_BASE64_SECRET;
const approovSecret = Buffer.from(approovBase64Secret, 'base64')Next, verify the Approov token:
const verifyApproovToken = function(req) {
const approovToken = req.headers['approov-token']
if (!approovToken) {
// You may want to add some logging here.
return false
}
// Decode the token with strict verification of the signature (['HS256']) to
// prevent against the `none` algorithm attack.
return jwt.verify(approovToken, approovSecret, { algorithms: ['HS256'] }, function(err, decoded) {
if (err) {
// You may want to add some logging here.
return false
}
// 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.
req.approovTokenClaims = decoded
return true
})
}Finally, invoke the check for each API endpoint you want to protect with Approov:
if (!verifyApproovToken(req)) {
res.statusCode = 401
res.end(JSON.stringify({}))
return
}Not enough details in the bare bones quickstart? No worries, check the detailed quickstarts that contain a more comprehensive set of instructions, including how to test the Approov integration.
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.
If you find any issue while following our instructions then just report it here, with the steps to reproduce it, and we will sort it out and/or guide you to the correct path.
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: