Scrub Personal Identifying Information Problem

Note: The input files contain unstructured JSON data

Application event tracking to external services often involves meta data about the user who took the action. When this event information is sent to a third party, we want to scrub all personally identifying data reported, without losing information about what fields were actually recorded.

In order to do this on different platforms, it is useful to implement a method called scrub() that will take a JSON object and an array of sensitive fields as an input and returns a modified JSON object that replaces alphanumeric characters with an asterisk ("*") from values corresponding to keys matching the sensitive field names.

For example, if the sensitive fields we want to "scrub" are name, phone, and email, a JSON input of:

{
  "name": "Kelly Doe",
  "email": "[email protected]",
  "id": 12324,
  "phone": "5551234567"
}

should return:

{
  "name": "***** ***",
  "email": "****@*******.***",
  "id": 12324,
  "phone": "**********"
}

Requirements

You will need to implement a command line executable that takes two arguments: a text file with a list of sensitive fields and a JSON file of user data to scrub. Calling ./scrub sensitive_fields.txt input.json should output a scrubbed JSON version of input.json with the keys in sensitive_fields.txt "scrubbed".

Any valid JSON input should be able to be handled. Value types for sensitive keys should be handled as follows:

• String: replace alphanumeric characters with "*"
• Number: convert to string and replace alphanumeric characters with "*"
• Boolean: replace entire value with "-"
• Array: each value of the array should be evaluated as described by other field types
• Object: if the key matches a sensitive field, all values of the nested object should be scrubbed as described by other field types. If the nested object does not correspond to a sensitive key, each key/value pair of the nested object should be evaluated as described by other field types
• null: value should be unmodified

Input, Output, and Sensitive Fields file tests provided

A handful of example test "scrubs" are in the ./tests/ directory. Each subdirectory has an input.json, sensitive_fields.txt, and corresponding output.json that is expected.

---

---

Solution in Golang

Installation Prerequisite

1. Install Golang if you don't have it already.

Note: This code was tested with Golang version: go1.19.1 darwin/amd64 on a Mac OS Version 10.15.7 (19H15).

Git clone this repo

git clone [email protected]:developertogo/scrub-pii.git
cd scrub-pii

See sample runs in the next section Sample Runs

Note:

• If you're on a macOS, you can simply use ./scrub-pii
• If you're on other OS, you can build it by running go build and then run the command line: ./scrupb-pii

Sample Runs

1. Usage

$ ./scrub-pii
Usage: scrub-pii <input json file> <sensitive fields file>

Command option: -h

$ ./scrub-pii -h
Usage of ./scrub-pii:
  -pretty
    	display pretty output; otherwise do: -pretty=false (default true)

2. Sample run on test 07_mixed_type_arrays

3. Sample run on test 06_nested_object with no pretty output (i.e. -pretty=false)

4. Sample run of all unit tests

5. Sample run of all unit tests with -v (verbose mode enabled)