Mask Sensitive Data in Logs

Data masking is a data protection technology aimed at preventing the exposure of sensitive information in various environments, thus supporting secure application testing and data analysis without compromising privacy.

The built-in data-mask plugin provided by API7 Enterprise can help remove or replace sensitive information in request headers, request bodies, and URL queries.

This guide will walk you through masking sensitive information in the URL-encoded request bodies using API7 Enterprise. The file-logger plugin used for logging in the example is only to show that information has been successfully masked. Adjust accordingly per your use case.

Prerequisite(s)

• Install API7 Enterprise.
• Have a running API in the gateway group.

Enable data-mask and file-logger Plugins

1. Select Published Services of your gateway group from the side navigation bar, then click the service you want to modify, for example, a no-version httpbin service.

2. Under the published service, select Routes from the side navigation bar.

3. Select your target route, for example, /anything.

4. Click + Enable Plugin.

5. Search for the data-mask plugin.

6. Click Enable.

7. In the dialog box, do the following：

   • Add the following configuration to the JSON Editor:

   {
   "request": [
   {
       "action": "remove",
       "body_format": "json",
       "name": "$.password",
       "type": "body"
   },
   {
       "action": "replace",
       "body_format": "json",
       "name": "users[*].token",
       "type": "body",
       "value": "*****"
   },
   {
       "action": "regex",
       "body_format": "json",
       "name": "$.users[*].credit.card",
       "regex": "(\\d+)\\-\\d+\\-\\d+\\-(\\d+)",
       "type": "body",
       "value": "$1-****-****-$2"
   }
   ]
   }
   • Click Enable.

8. Under the same route, click + Enable Plugin.

9. Search for the file-logger plugin.

10. Click Enable.

11. In the dialog box, do the following：

    • Add the following configuration to the JSON Editor:

    {
    "include_req_body": true,
    "path": "/tmp/mask-header.log"
    }
    • Click Enable.

Validate

1. To validate, send a request to the route:

curl -i "http://127.0.0.1:9080/anything" \
  --data-urlencode "password=abc" \
  --data-urlencode "token=xyz" \
  --data-urlencode "card=1234-1234-1234-1234"

You should receive an HTTP/1.1 200 OK response.

2. Go to your docker, navigate to the /tmp/mask-urlencoded-body.log file and examining the log content, you should see a log entry similar to the following:

{
  "request": {
    "uri": "/anything",
    "body": "token=*****&card=1234-****-****-1234",
    "method": "POST",
    "url": "http://127.0.0.1:9080/anything"
  }
}

Below is an interactive demo that provides a hands-on introduction to masking sensitive data in logs. You will better understand how to use it in API7 Enterprise by clicking and following the steps.

Additional Resource(s)

• Getting Started
  • Launch Your First API
• Plugin Hub
  • data-mask