Merge pull request #9 from securenative/dev

Remove pii data from headers

Author: inbaltako

.github/workflows/ci.yml

@@ -33,11 +33,6 @@ jobs:
       - name: Publish to codecov
         run: bash <(curl -s https://codecov.io/bash)
 
-      - name: Create changelog
-        uses: heinrichreimer/[email protected]
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-
       - name: Notify slack success
         if: success()
         env:

.gitignore

@@ -22,4 +22,5 @@ node_modules/
 dist/
 coverage/
 
-.idea
+.idea
+.phpunit.result

.phpunit.result.cache

@@ -211,5 +211,30 @@ Initialize sdk as shown above.
 $options = new SecureNativeOptions();
 $options->setProxyHeaders(["CF-Connecting-IP"]);
 
+SecureNative::init();
+``` 
+
+
+## Remove PII Data From Headers
+
+By default, SecureNative SDK remove any known pii headers from the received request.
+We also support using custom pii headers and regex matching via configuration, for example:
+
+### Option 1: Using config file
+```json
+{
+    "SECURENATIVE_API_KEY": "YOUR_API_KEY",
+    "SECURENATIVE_PII_HEADERS": ["apiKey"]
+}
+```
+
+Initialize sdk as shown above.
+
+### Options 2: Using ConfigurationBuilder
+
+```php
+$options = new SecureNativeOptions();
+$options->setPiiRegexPattern("/http_auth_/i");
+
 SecureNative::init();
 ```