Privacy-Blue: Presidio Service

Presidio provides fast identification and anonymization modules for private entities in text and images such as credit card numbers, names, locations, social security numbers, bitcoin wallets, US phone numbers, financial data and more.

The flow provides access to Presidio's APIs using the Presidio Service Node:

• HTTP POST /HealthCheck: Check if Presidio Anonymizer and Analyzer services are running. These services can run dockerized either locally on the device or on a remote server.
• HTTP POST /Presidio for Analysis: The Presidio analysis request on text data requires the data filed to be placed in msg.payload.data and the msg.function set to "analyze".
• HTTP POST /Presidio for Anonymization: The Presidio anonymization request requires the data filed to be placed in msg.payload.data, the msg.function set to "anonymize" and the action to perform on the data in the msg.payload.action field. The actions available to be requested for anonymizing data are the following:
  • redact
  • replace
  • mask
  • hash
  • encrypt
  • decrypt

You can find more information about the actions above in Presidio's API docs

Copy[{"id":"ff3d7b7d34a79a9f","type":"subflow","name":"Presidio Service","info":"","category":"Presidio","in":[],"out":[],"env":[{"name":"analyzer","type":"str","value":"","ui":{"icon":"font-awesome/fa-align-justify","label":{"en-US":"Analyzer"}}},{"name":"anonymizer","type":"str","value":"","ui":{"icon":"font-awesome/fa-align-justify","label":{"en-US":"Anonymizer"}}}],"meta":{"module":"node-red-contrib-presidio","version":"0.0.1","author":"Thodoris Ioannidis <[email protected]>","desc":"This is a service subflow that allows for interactions with the Microsoft Presidio Analyzer and Anonymizer services.","keywords":"privacy, analysis, anonymization","license":"Apache-2.0"},"color":"#E9967A","icon":"font-awesome/fa-user-circle-o"},{"id":"3995dd87858eb6db","type":"http in","z":"ff3d7b7d34a79a9f","name":"","url":"/init","method":"post","upload":false,"swaggerDoc":"","x":140,"y":100,"wires":[["1f919f4ee604b0d8"]]},{"id":"1f919f4ee604b0d8","type":"http response","z":"ff3d7b7d34a79a9f","name":"","statusCode":"","headers":{},"x":350,"y":100,"wires":[]},{"id":"70e89475283bd3b1","type":"http in","z":"ff3d7b7d34a79a9f","name":"","url":"/HealthCheck","method":"get","upload":false,"swaggerDoc":"","x":170,"y":200,"wires":[["9ed6c030f5211130","2ee9fdb930277f6b"]]},{"id":"f9ff29f24176b5dd","type":"http in","z":"ff3d7b7d34a79a9f","name":"","url":"/Presidio","method":"post","upload":false,"swaggerDoc":"","x":160,"y":340,"wires":[["94a2a056b0656334"]]},{"id":"372c406bc8578e0f","type":"http response","z":"ff3d7b7d34a79a9f","name":"","statusCode":"","headers":{},"x":1390,"y":340,"wires":[]},{"id":"286797bd2d5c03b1","type":"switch","z":"ff3d7b7d34a79a9f","name":"","property":"payload.function","propertyType":"msg","rules":[{"t":"eq","v":"analyze","vt":"str"},{"t":"eq","v":"anonymize","vt":"str"},{"t":"eq","v":"deanonymize","vt":"str"}],"checkall":"true","repair":false,"outputs":3,"x":770,"y":340,"wires":[["edb597e3a61299b0"],["386186fe0d67a3cb"],["e1f9ffcabd6fd91b"]]},{"id":"7a537092ef2d5463","type":"http response","z":"ff3d7b7d34a79a9f","name":"","statusCode":"","headers":{},"x":1190,"y":200,"wires":[]},{"id":"3c244c15d58e697f","type":"http request","z":"ff3d7b7d34a79a9f","name":"","method":"GET","ret":"txt","paytoqs":"ignore","url":"","tls":"","persist":false,"proxy":"","insecureHTTPParser":false,"authType":"","senderr":false,"headers":[],"x":710,"y":180,"wires":[["6892ac532b8e4429"]]},{"id":"9ed6c030f5211130","type":"function","z":"ff3d7b7d34a79a9f","name":"Check Analyzer Service Health","func":"msg.url = env.get('analyzer')+\"/health\";\nreturn msg;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":470,"y":180,"wires":[["3c244c15d58e697f"]]},{"id":"2ee9fdb930277f6b","type":"function","z":"ff3d7b7d34a79a9f","name":"Check Anonymizer Service Health","func":"msg.url = env.get('anonymizer') +\"/health\";\nreturn msg;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":480,"y":220,"wires":[["c08cefca1683a350"]]},{"id":"c08cefca1683a350","type":"http request","z":"ff3d7b7d34a79a9f","name":"","method":"GET","ret":"txt","paytoqs":"ignore","url":"","tls":"","persist":false,"proxy":"","authType":"","senderr":false,"x":710,"y":220,"wires":[["7c0e5a6eda0bccfa"]]},{"id":"94a2a056b0656334","type":"function","z":"ff3d7b7d34a79a9f","name":"Set Presidio Parameters and Analysis Entities","func":"const key = msg.payload.key || \"WmZq4t7w!z%C&F)J\"\nconst actions = {\n    \"redact\":{\n        \"type\":\"redact\"\n    },\n    \"replace\":{\n        \"type\":\"replace\",\n        \"new_value\":\"ANONYMIZED\"\n    },\n    \"mask\":{\n        \"type\":\"mask\",\n        \"masking_char\":\"*\",\n        \"chars_to_mask\":20,\n        \"from_end\":false\n    },\n    \"hash\":{\n        \"type\":\"hash\",\n        \"hash_type\":\"sha256\"\n    },\n    \"encrypt\":{\n        \"type\":\"encrypt\",\n        \"key\": key\n    },\n    \"decrypt\":{\n        \"type\":\"decrypt\",\n        \"key\": key\n    }\n}\n\naction = actions[msg.payload.action];\n\nmsg.anonymizers = {\n    \"PERSON\":action,\n    \"US_DRIVER_LICENSE\":action,\n    \"PHONE_NUMBER\":action,\n    \"US_PASSPORT\":action,\n    \"LOCATION\":action,\n    \"CREDIT_CARD\":action,\n    \"CRYPTO\":action,\n    \"UK_NHS\":action,\n    \"US_SSN\":action,\n    \"US_BANK_NUMBER\":action,\n    \"EMAIL_ADDRESS\":action,\n    \"DATE_TIME\":action,\n    \"IP_ADDRESS\":action,\n    \"IBAN_CODE\":action,\n    \"NRP\":action,\n    \"US_ITIN\":action,\n    \"MEDICAL_LICENSE\":action,\n    \"URL\":action\n}\n\nmsg.analyzer = env.get('analyzer')\nmsg.anonymizer = env.get('anonymizer')\n\nreturn msg;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":480,"y":340,"wires":[["286797bd2d5c03b1"]]},{"id":"20b56924bb1d27bd","type":"join","z":"ff3d7b7d34a79a9f","name":"","mode":"custom","build":"object","property":"payload","propertyType":"msg","key":"topic","joiner":"\\n","joinerType":"str","accumulate":false,"timeout":"","count":"2","reduceRight":false,"reduceExp":"","reduceInit":"","reduceInitType":"num","reduceFixup":"","x":1010,"y":200,"wires":[["7a537092ef2d5463"]]},{"id":"6892ac532b8e4429","type":"change","z":"ff3d7b7d34a79a9f","name":"TOPIC","rules":[{"t":"set","p":"topic","pt":"msg","to":"Analyzer","tot":"str"}],"action":"","property":"","from":"","to":"","reg":false,"x":870,"y":180,"wires":[["20b56924bb1d27bd"]]},{"id":"7c0e5a6eda0bccfa","type":"change","z":"ff3d7b7d34a79a9f","name":"TOPIC","rules":[{"t":"set","p":"topic","pt":"msg","to":"Anonymizer","tot":"str"}],"action":"","property":"","from":"","to":"","reg":false,"x":870,"y":220,"wires":[["20b56924bb1d27bd"]]},{"id":"edb597e3a61299b0","type":"function","z":"ff3d7b7d34a79a9f","name":"Prepare Analysis","func":"msg.url = msg.analyzer +\"/analyze\";\n\nmsg.tmpPayload = msg.payload;\nmsg.text = msg.payload.data;\n\nmsg.header = \"Content-Type: application/json\";\nmsg.payload = {\n    text: msg.text,\n    language:\"en\"\n};\n\nreturn msg;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":1010,"y":300,"wires":[["5884e761f81987a1"]]},{"id":"5884e761f81987a1","type":"http request","z":"ff3d7b7d34a79a9f","name":"Analyze","method":"POST","ret":"obj","paytoqs":"ignore","url":"","tls":"","persist":false,"proxy":"","insecureHTTPParser":false,"authType":"","senderr":false,"headers":[],"x":1180,"y":300,"wires":[["372c406bc8578e0f"]]},{"id":"386186fe0d67a3cb","type":"function","z":"ff3d7b7d34a79a9f","name":"Prepare Analysis","func":"msg.url = msg.analyzer +\"/analyze\";\n\nmsg.tmpPayload = msg.payload;\nmsg.text = msg.payload.data;\n\nmsg.header = \"Content-Type: application/json\";\nmsg.payload = {\n    text: msg.text,\n    language:\"en\"\n};\n\nreturn msg;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":1010,"y":340,"wires":[["0d63dfd0dc4f089d"]]},{"id":"0d63dfd0dc4f089d","type":"http request","z":"ff3d7b7d34a79a9f","name":"Analyze","method":"POST","ret":"obj","paytoqs":"ignore","url":"","tls":"","persist":false,"proxy":"","authType":"","senderr":false,"x":1180,"y":340,"wires":[["3b80f6923b9f8eb9"]]},{"id":"3b80f6923b9f8eb9","type":"function","z":"ff3d7b7d34a79a9f","name":"Prepare Anonymization","func":"msg.url = msg.anonymizer+\"/anonymize\";\n\nanalyzerResults = msg.payload;\nanonymizers = msg.anonymizers;\nmsg.actions = {};\n\nfor(let i in anonymizers){\n    for(let y in analyzerResults){\n        if(analyzerResults[y].entity_type == i){\n            msg.actions[analyzerResults[y].entity_type] = anonymizers[i];\n            break;    \n        }\n    }\n}\n\nmsg.header = \"Content-Type: application/json\";\n\nmsg.payload = {};\nmsg.payload[\"text\"] = msg.text;\nmsg.payload[\"anonymizers\"] = msg.actions;\nmsg.payload[\"analyzer_results\"] = analyzerResults;\n\nreturn msg;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":1030,"y":400,"wires":[["0254f9d2510d8b35"]]},{"id":"0254f9d2510d8b35","type":"http request","z":"ff3d7b7d34a79a9f","name":"Anonymize / Deanonymize","method":"POST","ret":"obj","paytoqs":"ignore","url":"","tls":"","persist":false,"proxy":"","authType":"","senderr":false,"x":1300,"y":420,"wires":[["372c406bc8578e0f"]]},{"id":"e1f9ffcabd6fd91b","type":"function","z":"ff3d7b7d34a79a9f","name":"Prepare Deanonymization","func":"msg.url = msg.anonymizer+\"/deanonymize\";\nmsg.text = msg.payload.text;\nanonymizerResults = msg.payload.items;\ndeanonymizers = msg.anonymizers;\nmsg.actions = {};\nmsg.results = []\n\nfor(let i in deanonymizers){\n    for(let y in anonymizerResults){\n        if(anonymizerResults[y].entity_type == i){\n            msg.actions[anonymizerResults[y].entity_type] = deanonymizers[i];\n            msg.results.push({\n                start: anonymizerResults[y].start,\n                end: anonymizerResults[y].end,\n                entity_type: anonymizerResults[y].entity_type\n            })\n            break;    \n        }\n    }\n}\n\nmsg.header = \"Content-Type: application/json\";\n\nmsg.payload = {};\nmsg.payload[\"text\"] = msg.text;\nmsg.payload[\"deanonymizers\"] = msg.actions;\nmsg.payload[\"anonymizer_results\"] = msg.results;\n\nreturn msg;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":1030,"y":440,"wires":[["0254f9d2510d8b35"]]},{"id":"ded680a8b69e6c46","type":"inject","z":"799e054716dc27fe","name":"Presidio Health Check","props":[],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"","x":200,"y":200,"wires":[["f4e91c40dd156f6e"]]},{"id":"dfb331e211c2c2bc","type":"comment","z":"799e054716dc27fe","name":"Health Check","info":"","x":430,"y":160,"wires":[]},{"id":"d0b09f6f775181e0","type":"subflow:ff3d7b7d34a79a9f","z":"799e054716dc27fe","name":"","env":[{"name":"analyzer","value":"http://192.168.2.11:5001","type":"str"},{"name":"anonymizer","value":"http://192.168.2.11:5002","type":"str"}],"x":180,"y":160,"wires":[]},{"id":"f4e91c40dd156f6e","type":"http request","z":"799e054716dc27fe","name":"/HealthCheck","method":"GET","ret":"txt","paytoqs":"ignore","url":"localhost:1880/HealthCheck","tls":"","persist":false,"proxy":"","insecureHTTPParser":false,"authType":"","senderr":false,"headers":[],"x":440,"y":200,"wires":[["17375cda3e4bb468"]]},{"id":"b6bd228709b8bcac","type":"debug","z":"799e054716dc27fe","name":"Print Results","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","targetType":"msg","statusVal":"","statusType":"auto","x":770,"y":200,"wires":[]},{"id":"17375cda3e4bb468","type":"json","z":"799e054716dc27fe","name":"","property":"payload","action":"obj","pretty":false,"x":610,"y":200,"wires":[["b6bd228709b8bcac"]]},{"id":"48cb288629cf6d1f","type":"inject","z":"799e054716dc27fe","name":"Presidio Analysis","props":[{"p":"payload.function","v":"analyze","vt":"str"},{"p":"payload.data","v":"Hello my name is Tommy Bilboa","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"","x":180,"y":280,"wires":[["2763c77726f0a5e3"]]},{"id":"2763c77726f0a5e3","type":"http request","z":"799e054716dc27fe","name":"/Presidio","method":"POST","ret":"txt","paytoqs":"ignore","url":"localhost:1880/Presidio","tls":"","persist":false,"proxy":"","insecureHTTPParser":false,"authType":"","senderr":false,"headers":[],"x":420,"y":280,"wires":[["1de1c4b6abf925ce"]]},{"id":"c3935bf1aef559fd","type":"inject","z":"799e054716dc27fe","name":"Presidio Anonymization","props":[{"p":"payload.action","v":"hash","vt":"str"},{"p":"payload.data","v":"Hello my name is Tom Blue","vt":"str"},{"p":"payload.function","v":"anonymize","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"","x":200,"y":340,"wires":[["e49c3e80ad813f30"]]},{"id":"9fe74cea5e50c365","type":"inject","z":"799e054716dc27fe","name":"Presidio Deanonymization","props":[{"p":"payload.function","v":"deanonymize","vt":"str"},{"p":"payload.key","v":"WmZq4t7w!z%C&F)K","vt":"str"},{"p":"payload.action","v":"decrypt","vt":"str"},{"p":"payload.text","v":"Hello my name is 44GzjK7hzV110QNLuknYeZ+sbe8Rw144vVFzYulz8Vg= and my phone number is 56KvSbJUhML8EBmZoQgYTEI25m6lmgb+8mjVI9em90A=","vt":"str"},{"p":"payload.items","v":"[{\"start\":85,\"end\":129,\"entity_type\":\"DATE_TIME\",\"text\":\"56KvSbJUhML8EBmZoQgYTEI25m6lmgb+8mjVI9em90A=\",\"operator\":\"encrypt\"},{\"start\":17,\"end\":61,\"entity_type\":\"PERSON\",\"text\":\"44GzjK7hzV110QNLuknYeZ+sbe8Rw144vVFzYulz8Vg=\",\"operator\":\"encrypt\"}]","vt":"json"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"","x":210,"y":400,"wires":[["e49c3e80ad813f30"]]},{"id":"f77062463dd71d3d","type":"comment","z":"799e054716dc27fe","name":"Analyzer API","info":"","x":430,"y":240,"wires":[]},{"id":"3f9c6b7ee5a6b749","type":"comment","z":"799e054716dc27fe","name":"Anonymizer API","info":"","x":440,"y":320,"wires":[]},{"id":"826506221b049ab9","type":"debug","z":"799e054716dc27fe","name":"Print Results","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","targetType":"msg","statusVal":"","statusType":"auto","x":770,"y":280,"wires":[]},{"id":"1de1c4b6abf925ce","type":"json","z":"799e054716dc27fe","name":"","property":"payload","action":"obj","pretty":false,"x":610,"y":280,"wires":[["826506221b049ab9"]]},{"id":"e49c3e80ad813f30","type":"http request","z":"799e054716dc27fe","name":"/Presidio","method":"POST","ret":"txt","paytoqs":"ignore","url":"localhost:1880/Presidio","tls":"","persist":false,"proxy":"","insecureHTTPParser":false,"authType":"","senderr":false,"headers":[],"x":420,"y":360,"wires":[["06c4652e3c2da5b3"]]},{"id":"06c4652e3c2da5b3","type":"json","z":"799e054716dc27fe","name":"","property":"payload","action":"obj","pretty":false,"x":610,"y":360,"wires":[["bd2811eb1854589e"]]},{"id":"bd2811eb1854589e","type":"debug","z":"799e054716dc27fe","name":"Print Results","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","targetType":"msg","statusVal":"","statusType":"auto","x":770,"y":360,"wires":[]}]