From 8b642e20a2954c15122f6a60412d459647d0a741 Mon Sep 17 00:00:00 2001 From: Tomer Rosenthal Date: Wed, 19 Dec 2018 21:37:43 +0200 Subject: [PATCH] Version 0.1.1 (#82) * Docs (#80) * Fixed Anonymizer duplicates bug (#81) --- NOTICE | 206 ------------------ README.MD | 88 ++++---- docs/development.md | 21 +- docs/overview.md | 35 +-- docs/tutorial_framework.md | 24 +- docs/tutorial_service.md | 45 ++-- presidio-analyzer/tests/data/demo.txt | 11 +- .../anonymizer/anonymizer.go | 35 ++- .../anonymizer/anonymizer_test.go | 164 ++++++++++++++ 9 files changed, 324 insertions(+), 305 deletions(-) diff --git a/NOTICE b/NOTICE index 0ee6aaff2..c8d679b59 100644 --- a/NOTICE +++ b/NOTICE @@ -29,212 +29,6 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -******* -confluent-kafka-go - -Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "{}" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright {yyyy} {name of copyright owner} - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - ******* redis diff --git a/README.MD b/README.MD index f9e71ce84..f2de8b567 100644 --- a/README.MD +++ b/README.MD @@ -1,14 +1,13 @@ [![Build status](https://dev.azure.com/csedevil/Presidio/_apis/build/status/Presidio-CI)](https://dev.azure.com/csedevil/Presidio/_build/latest?definitionId=48) - # Presidio - Data Loss Prevention API -**Context aware, born to the cloud, customizable data loss prevention service** +**Context aware, born to the cloud, customizable data loss prevention service** ## Description -Presidio *(Origin from Latin praesidium ‘protection, garrison’)* helps to ensure sensitive text is properly managed and governed. It provides fast ***analytics*** and ***anonymization*** for sensitive text such as credit card numbers, bitcoin wallets, names, locations, social security numbers, US phone numbers and financial data. -Presidio analyzes the text using predefined analyzers to identify patterns, formats, and checksums with relevant context. +Presidio *(Origin from Latin praesidium ‘protection, garrison’)* helps to ensure sensitive text is properly managed and governed. It provides fast ***analytics*** and ***anonymization*** for sensitive text such as credit card numbers, bitcoin wallets, names, locations, social security numbers, US phone numbers and financial data. +Presidio analyzes the text using predefined analyzers to identify patterns, formats, and checksums with relevant context. You can find a more detailed list [here](https://microsoft.github.io/presidio/field_types.html) @@ -19,25 +18,28 @@ You can find a more detailed list [here](https://microsoft.github.io/presidio/fi * Text analytics - Predefined analyzers with customizable fields. * Probability scores - Customize the sensitive text detection threshold. * Anonymization - Anonymize sensitive text and images -* Workflow and pipeline integration - Monitor your data with periodic scans or events of +* Workflow and pipeline integration - Monitor your data with periodic scans or events of/from: 1. Storage solutions - - Azure Blob Storage - - S3 - - Google Cloud Storage + * Azure Blob Storage + * S3 + * Google Cloud Storage 2. Databases - - MySQL - - PostgreSQL - - Sql Server - - Oracle + * MySQL + * PostgreSQL + * Sql Server + * Oracle + 3. Streaming platforms + * Kafka + * Azure Events Hubs and export the results for further analytics: - 1. Databases - 2. Streaming platform - - Kafka - - Azure Events Hubs + 1. Storage solutions + 2. Databases + 3. Streaming platforms ## The Technology Stack -Presidio leverages + +Presidio leverages: * [Kubernetes](https://kubernetes.io/) * [spaCy](https://spacy.io/) @@ -57,49 +59,49 @@ The [design document](https://microsoft.github.io/presidio/design.html) introduc **Note:** Examples are made with [HTTPie](https://httpie.org/) ***Sample 1*** + 1. Analyze text -``` -echo -n '{"text":"John Smith lives in New York. We met yesterday morning in Seattle. I called him before on (212) 555-1234 to verify the appointment. He also told me that his drivers license is AC333991", "analyzeTemplate":{"fields":[]} }' | http /api/v1/projects//analyze -``` + ```sh + echo -n '{"text":"John Smith lives in New York. We met yesterday morning in Seattle. I called him before on (212) 555-1234 to verify the appointment. He also told me that his drivers license is AC333991", "analyzeTemplate":{"fields":[]} }' | http /api/v1/projects//analyze + ``` ***Sample 2*** -You can also create reusable templates +You can also create reusable templates 1. Create an analyzer project -``` -echo -n '{"fields":[]}' | http /api/v1/templates//analyze/ -``` + ```sh + echo -n '{"fields":[]}' | http /api/v1/templates//analyze/ + ``` 2. Analyze text -``` -echo -n '{"text":"my credit card number is 2970-84746760-9907 345954225667833 4961-2765-5327-5913", "AnalyzeTemplateId":"" }' | http /api/v1/projects//analyze -``` + ```sh + echo -n '{"text":"my credit card number is 2970-84746760-9907 345954225667833 4961-2765-5327-5913", "AnalyzeTemplateId":"" }' | http /api/v1/projects//analyze + ``` ***Sample 3*** 1. Create an analyzer project -``` -echo -n '{"fields":[{"name":"PHONE_NUMBER"}, {"name":"LOCATION"}, {"name":"DATE_TIME"}]}' | http /api/v1/templates//analyze/ -``` + ```sh + echo -n '{"fields":[{"name":"PHONE_NUMBER"}, {"name":"LOCATION"}, {"name":"DATE_TIME"}]}' | http /api/v1/templates//analyze/ + ``` 2. Analyze text -``` -echo -n '{"text":"We met yesterday morning in Seattle and his phone number is (212) 555 1234", "AnalyzeTemplateId":"" }' | http /api/v1/projects//analyze -``` + ```sh + echo -n '{"text":"We met yesterday morning in Seattle and his phone number is (212) 555 1234", "AnalyzeTemplateId":"" }' | http /api/v1/projects//analyze + ``` ***Sample 4*** 1. Create an anonymizer template (This template replaces values in PHONE_NUMBER and redacts CREDIT_CARD) -``` -echo -n '{"fieldTypeTransformations":[{"fields":[{"name":"PHONE_NUMBER"}],"transformation":{"replaceValue":{"newValue":"\u003cphone-number\u003e"}}},{"fields":[{"name":"CREDIT_CARD"}],"transformation":{"redactValue":{}}}]}' | http /api/v1/templates//anonymize/ -``` + ```sh + echo -n '{"fieldTypeTransformations":[{"fields":[{"name":"PHONE_NUMBER"}],"transformation":{"replaceValue":{"newValue":"\u003cphone-number\u003e"}}},{"fields":[{"name":"CREDIT_CARD"}],"transformation":{"redactValue":{}}}]}' | http /api/v1/templates//anonymize/ + ``` 2. Anonymize text -``` -echo -n '{"text":"my phone number is 057-555-2323 and my credit card is 4961-2765-5327-5913", "AnalyzeTemplateId":"", "AnonymizeTemplateId":"" }' | http /api/v1/projects//anonymize -``` - + ```sh + echo -n '{"text":"my phone number is 057-555-2323 and my credit card is 4961-2765-5327-5913", "AnalyzeTemplateId":"", "AnonymizeTemplateId":"" }' | http /api/v1/projects//anonymize + ``` ### Current Features Status @@ -125,9 +127,9 @@ echo -n '{"text":"my phone number is 057-555-2323 and my credit card is 4961-276 | Datasink (output) | S3 | :white_check_mark: | | Datasink (output) | Google Cloud Storage | :x: | -- :white_check_mark: - Working -- :large_orange_diamond: - Partially working -- :x: - Not working yet but we are on it :wink: +* :white_check_mark: - Working +* :large_orange_diamond: - Partially working +* :x: - Not working yet but we are on it :wink: # Contributing diff --git a/docs/development.md b/docs/development.md index 2a3ba01c0..2cf8ef778 100644 --- a/docs/development.md +++ b/docs/development.md @@ -1,5 +1,5 @@ -# Development +# Development ## Setting up the environment @@ -60,8 +60,8 @@ protoc -I . --go_out=plugins=grpc:../golang ./*.proto ``` - ## Development notes + - Build the bins with `make build` - Build the the Docker image with `make docker-build` - Push the Docker images with `make docker-push` @@ -69,6 +69,23 @@ - Adding a file in go requires the `make go-format` command before running and building the service. - Run functional tests with `make test-functional` +### Set the following environnement variables + +#### presidio-analyzer + +- `GRPC_PORT`: `3001` GRPC listen port + +#### presidio-anonymizer + +- `GRPC_PORT`: `3002` GRPC listen port + +#### presidio-api + +- `WEB_PORT`: `8080` HTTP listen port +- `REDIS_URL`: `localhost:6379`, Optional: Redis address +- `ANALYZER_SVC_ADDRESS`: `localhost:3001`, Analyzer address +- `ANONYMIZER_SVC_ADDRESS`: `localhost:3002`, Anonymizer address + ## Load test 1. Edit `post.lua`. Change the template name diff --git a/docs/overview.md b/docs/overview.md index 80c8e4bfe..5442acdfa 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -1,31 +1,36 @@ # Presidio overview +Presidio *(Origin from Latin praesidium ‘protection, garrison’)* helps to ensure sensitive text is properly managed and governed. It provides fast ***analytics*** and ***anonymization*** for sensitive text such as credit card numbers, bitcoin wallets, names, locations, social security numbers, US phone numbers and financial data. +Presidio analyzes the text using predefined analyzers to identify patterns, formats, and checksums with relevant context. -Presidio helps to ensure sensitive text is properly managed and governed. It provides fast analytics and anonymization for sensitive text such as credit card numbers, bitcoin wallets, names, locations, social security numbers, US phone numbers and financial data. Presidio analyzes the text using predefined analyzers to identify patterns, formats, and checksums with relevant context. +You can find a more detailed list [here](https://microsoft.github.io/presidio/field_types.html) + +:warning: ***Presidio can help identify sensitive/PII data in un/structured text. However, because Presidio is using trained ML models, there is no guarantee that Presidio will find all sensitive information. Consequently, additional systems and protections should be employed.*** ## Features * Text analytics - Predefined analyzers with customizable fields. * Probability scores - Customize the sensitive text detection threshold. * Anonymization - Anonymize sensitive text and images -* Workflow and pipeline integration - Monitor your data with periodic scans or events of +* Workflow and pipeline integration - Monitor your data with periodic scans or events of/from: 1. Storage solutions - - Azure Blob Storage - - S3 - - Google Cloud Storage + * Azure Blob Storage + * S3 + * Google Cloud Storage 2. Databases - - MySQL - - PostgreSQL - - Sql Server - - Oracle + * MySQL + * PostgreSQL + * Sql Server + * Oracle + 3. Streaming platforms + * Kafka + * Azure Events Hubs and export the results for further analytics: - 1. Databases - 2. Data Warehouse - 3. Streaming platform - - Kafka - - Azure Events Hubs - + 1. Storage solutions + 2. Databases + 3. Streaming platforms + --- Prev: [Docs Index](index.md) `|` Next: [Install Guide](install.md) \ No newline at end of file diff --git a/docs/tutorial_framework.md b/docs/tutorial_framework.md index 1fbdcd7ec..ac974e81d 100644 --- a/docs/tutorial_framework.md +++ b/docs/tutorial_framework.md @@ -6,18 +6,21 @@ See [Install Presidio](install.md#L5) for a tutorial on how to install Presidio. ## Analyze your text data +### Method 1 + First, we need to serve our model. We can do that very easily with (Takes about 10 seconds to load) -``` -$ ./presidio-analyzer serve -``` + ```sh + $ ./presidio-analyzer serve + ``` Now that our model is up and running, we can send PII text to it. *From another shell* -``` -$ ./presidio-analyzer analyze --text "John Smith drivers license is AC432223" --fields "PERSON" "US_DRIVER_LICENSE" -``` + + ```sh + $ ./presidio-analyzer analyze --text "John Smith drivers license is AC432223" --fields "PERSON" "US_DRIVER_LICENSE" + ``` The expected result is: @@ -51,3 +54,12 @@ The expected result is: ] } ``` + +### Method 2 + +Use the analyzer Python code by importing `matcher.py` from `presidio-analyzer/analyzer` + +```python +match = matcher.Matcher() +results = self.match.analyze_text(text, fields) +``` \ No newline at end of file diff --git a/docs/tutorial_service.md b/docs/tutorial_service.md index b82f41d24..da29d009e 100644 --- a/docs/tutorial_service.md +++ b/docs/tutorial_service.md @@ -1,45 +1,46 @@ **Note:** Examples are made with [HTTPie](https://httpie.org/) ***Sample 1*** + 1. Analyze text -``` -echo -n '{"text":"John Smith lives in New York. We met yesterday morning in Seattle. I called him before on (212) 555-1234 to verify the appointment. He also told me that his drivers license is AC333991", "analyzeTemplate":{"fields":[]} }' | http /api/v1/projects//analyze -``` + ```sh + echo -n '{"text":"John Smith lives in New York. We met yesterday morning in Seattle. I called him before on (212) 555-1234 to verify the appointment. He also told me that his drivers license is AC111921", "analyzeTemplate":{"fields":[]} }' | http /api/v1/projects//analyze + ``` ***Sample 2*** -You can also create reusable templates +You can also create reusable templates 1. Create an analyzer project -``` -echo -n '{"fields":[]}' | http /api/v1/templates//analyze/ -``` + ```sh + echo -n '{"fields":[]}' | http /api/v1/templates//analyze/ + ``` 2. Analyze text -``` -echo -n '{"text":"my credit card number is 2970-84746760-9907 345954225667833 4961-2765-5327-5913", "AnalyzeTemplateId":"" }' | http /api/v1/projects//analyze -``` + ```sh + echo -n '{"text":"my credit card number is 2970-84746760-9907 345954225667833 4961-2765-5327-5913", "AnalyzeTemplateId":"" }' | http /api/v1/projects//analyze + ``` ***Sample 3*** 1. Create an analyzer project -``` -echo -n '{"fields":[{"name":"PHONE_NUMBER"}, {"name":"LOCATION"}, {"name":"DATE_TIME"}]}' | http /api/v1/templates//analyze/ -``` + ```sh + echo -n '{"fields":[{"name":"PHONE_NUMBER"}, {"name":"LOCATION"}, {"name":"DATE_TIME"}]}' | http /api/v1/templates//analyze/ + ``` 2. Analyze text -``` -echo -n '{"text":"We met yesterday morning in Seattle and his phone number is (212) 555 1234", "AnalyzeTemplateId":"" }' | http /api/v1/projects//analyze -``` + ```sh + echo -n '{"text":"We met yesterday morning in Seattle and his phone number is (212) 555 1234", "AnalyzeTemplateId":"" }' | http /api/v1/projects//analyze + ``` ***Sample 4*** 1. Create an anonymizer template (This template replaces values in PHONE_NUMBER and redacts CREDIT_CARD) -``` -echo -n '{"fieldTypeTransformations":[{"fields":[{"name":"PHONE_NUMBER"}],"transformation":{"replaceValue":{"newValue":"\u003cphone-number\u003e"}}},{"fields":[{"name":"CREDIT_CARD"}],"transformation":{"redactValue":{}}}]}' | http /api/v1/templates//anonymize/ -``` + ```sh + echo -n '{"fieldTypeTransformations":[{"fields":[{"name":"PHONE_NUMBER"}],"transformation":{"replaceValue":{"newValue":"\u003cphone-number\u003e"}}},{"fields":[{"name":"CREDIT_CARD"}],"transformation":{"redactValue":{}}}]}' | http /api/v1/templates//anonymize/ + ``` 2. Anonymize text -``` -echo -n '{"text":"my phone number is 057-555-2323 and my credit card is 4961-2765-5327-5913", "AnalyzeTemplateId":"", "AnonymizeTemplateId":"" }' | http /api/v1/projects//anonymize -``` \ No newline at end of file + ```sh + echo -n '{"text":"my phone number is 057-555-2323 and my credit card is 4961-2765-5327-5913", "AnalyzeTemplateId":"", "AnonymizeTemplateId":"" }' | http /api/v1/projects//anonymize + ``` \ No newline at end of file diff --git a/presidio-analyzer/tests/data/demo.txt b/presidio-analyzer/tests/data/demo.txt index b877bbff3..87e3a1657 100644 --- a/presidio-analyzer/tests/data/demo.txt +++ b/presidio-analyzer/tests/data/demo.txt @@ -1,11 +1,6 @@ -Presidio helps to ensure sensitive text is properly managed and governed. -It provides fast analytics and anonymization for sensitive text such as credit card numbers, bitcoin wallets, names, locations, -social security numbers, phone numbers and financial data. Presidio analyzes the text using predefined analyzers to identify patterns, -formats, and checksums with relevant context. - Here are a few examples of entities we currently support: - Credit card: 4012-8888-8888-1881 + Credit card: 4095-2609-9393-4932 Crypto wallet id: 16Yeky6GMjeNkAiNcBY7ZhrLoMSgg1BoyZ DateTime: September 18 Domain: microsoft.com @@ -15,10 +10,10 @@ Here are a few examples of entities we currently support: Person name: David Johnson Bank account: 945456787654 - Driver license number: AC3549211 + Driver license number: H12234567 Itin: 911-70-1234 Passport: 912803456 - Phone number: (555) 253-0000. + Phone number: (212) 555-1234. Social security number: 078-05-1120 This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring t diff --git a/presidio-anonymizer/cmd/presidio-anonymizer/anonymizer/anonymizer.go b/presidio-anonymizer/cmd/presidio-anonymizer/anonymizer/anonymizer.go index 75b7812be..5a6a6dec7 100644 --- a/presidio-anonymizer/cmd/presidio-anonymizer/anonymizer/anonymizer.go +++ b/presidio-anonymizer/cmd/presidio-anonymizer/anonymizer/anonymizer.go @@ -11,9 +11,17 @@ import ( type sortedResults []*types.AnalyzeResult -func (a sortedResults) Len() int { return len(a) } -func (a sortedResults) Swap(i, j int) { a[i], a[j] = a[j], a[i] } -func (a sortedResults) Less(i, j int) bool { return a[i].Location.Start < a[j].Location.Start } +func (a sortedResults) Len() int { return len(a) } +func (a sortedResults) Swap(i, j int) { a[i], a[j] = a[j], a[i] } +func (a sortedResults) Less(i, j int) bool { + if a[i].Location.Start < a[j].Location.Start { + return true + } + if a[i].Location.Start > a[j].Location.Start { + return false + } + return a[i].Score > a[j].Score +} //ApplyAnonymizerTemplate ... func ApplyAnonymizerTemplate(text string, results []*types.AnalyzeResult, template *types.AnonymizeTemplate) (string, error) { @@ -21,6 +29,11 @@ func ApplyAnonymizerTemplate(text string, results []*types.AnalyzeResult, templa //Sort results by start location to verify order sort.Sort(sortedResults(results)) + //Remove duplicates based on score + if len(results) > 1 { + results = removeDuplicatesBaseOnScore(results) + } + //Apply new values var err error for i := len(results) - 1; i >= 0; i-- { @@ -55,6 +68,22 @@ func ApplyAnonymizerTemplate(text string, results []*types.AnalyzeResult, templa return text, nil } +func removeDuplicatesBaseOnScore(results []*types.AnalyzeResult) []*types.AnalyzeResult { + + j := 0 + for i := 1; i < len(results); i++ { + if results[j].Location.Start == results[i].Location.Start && results[j].Location.End == results[i].Location.End { + continue + } + j++ + + // Swap + results[i], results[j] = results[j], results[i] + } + + return results[:j+1] +} + func transformField(transformation *types.Transformation, result *types.AnalyzeResult, text string) (string, error) { if transformation.ReplaceValue != nil { diff --git a/presidio-anonymizer/cmd/presidio-anonymizer/anonymizer/anonymizer_test.go b/presidio-anonymizer/cmd/presidio-anonymizer/anonymizer/anonymizer_test.go index 5edafb164..d2b76b20e 100644 --- a/presidio-anonymizer/cmd/presidio-anonymizer/anonymizer/anonymizer_test.go +++ b/presidio-anonymizer/cmd/presidio-anonymizer/anonymizer/anonymizer_test.go @@ -3,6 +3,8 @@ package anonymizer import ( "testing" + "encoding/json" + "github.com/stretchr/testify/assert" types "github.com/Microsoft/presidio-genproto/golang" @@ -160,6 +162,97 @@ var testPlans = []struct { }, }, }}, +}, { + desc: "Detect duplicate element", + text: "My name is danger and my location is Seattle", + expected: "My name is and my location is ", + analyzeResults: []*types.AnalyzeResult{{ + Location: &types.Location{ + Start: 11, + End: 17, + }, + Score: 0.2, + Field: &types.FieldTypes{ + Name: types.FieldTypesEnum_LOCATION.String(), + }, + }, + { + Location: &types.Location{ + Start: 11, + End: 17, + }, + Score: 0.85, + Field: &types.FieldTypes{ + Name: types.FieldTypesEnum_PERSON.String(), + }, + }, + { + Location: &types.Location{ + Start: 11, + End: 17, + }, + Score: 0.65, + Field: &types.FieldTypes{ + Name: types.FieldTypesEnum_NRP.String(), + }, + }, + { + Location: &types.Location{ + Start: 37, + End: 44, + }, + Score: 0.35, + Field: &types.FieldTypes{ + Name: types.FieldTypesEnum_DATE_TIME.String(), + }, + }, + { + Location: &types.Location{ + Start: 37, + End: 44, + }, + Score: 0.65, + Field: &types.FieldTypes{ + Name: types.FieldTypesEnum_LOCATION.String(), + }, + }}, + fieldTypeTransformation: []*types.FieldTypeTransformation{{ + Fields: []*types.FieldTypes{{ + Name: types.FieldTypesEnum_PERSON.String(), + }}, + Transformation: &types.Transformation{ + ReplaceValue: &types.ReplaceValue{ + NewValue: "", + }, + }, + }, { + Fields: []*types.FieldTypes{{ + Name: types.FieldTypesEnum_LOCATION.String(), + }}, + Transformation: &types.Transformation{ + ReplaceValue: &types.ReplaceValue{ + NewValue: "", + }, + }, + }, { + Fields: []*types.FieldTypes{{ + Name: types.FieldTypesEnum_NRP.String(), + }}, + Transformation: &types.Transformation{ + ReplaceValue: &types.ReplaceValue{ + NewValue: "", + }, + }, + }, { + Fields: []*types.FieldTypes{{ + Name: types.FieldTypesEnum_DATE_TIME.String(), + }}, + Transformation: &types.Transformation{ + ReplaceValue: &types.ReplaceValue{ + NewValue: "", + }, + }, + }}, }, } @@ -177,3 +270,74 @@ func TestPlan(t *testing.T) { assert.Equal(t, plan.expected, output) } } + +func TestMultipleValuesBasedOnJSON(t *testing.T) { + var analyzeResultsJSON = `[{"text":"4095-2609-9393-4932","field":{"name":"CREDIT_CARD"},"score":1,"location":{"start":76,"end":95,"length":19}},{"text":"16Yeky6GMjeNkAiNcBY7ZhrLoMSgg1BoyZ","field":{"name":"CRYPTO"},"score":1,"location":{"start":118,"end":152,"length":34}},{"text":"September 18","field":{"name":"DATE_TIME"},"score":0.85,"location":{"start":167,"end":179,"length":12}},{"text":"microsoft.com","field":{"name":"DOMAIN_NAME"},"score":1,"location":{"start":192,"end":205,"length":13}},{"text":"test@presidio.site","field":{"name":"EMAIL_ADDRESS"},"score":1,"location":{"start":225,"end":243,"length":18}},{"text":"presidio.site","field":{"name":"DOMAIN_NAME"},"score":1,"location":{"start":230,"end":243,"length":13}},{"text":"IL150120690000003111111","field":{"name":"IBAN_CODE"},"score":1,"location":{"start":254,"end":277,"length":23}},{"text":"192.168.0.1","field":{"name":"IP_ADDRESS"},"score":0.95,"location":{"start":286,"end":297,"length":11}},{"text":"David Johnson","field":{"name":"PERSON"},"score":0.85,"location":{"start":315,"end":328,"length":13}},{"text":"2854567876542","field":{"name":"US_BANK_NUMBER"},"score":0.6,"location":{"start":348,"end":361,"length":13}},{"text":"H12234567","field":{"name":"US_DRIVER_LICENSE"},"score":0.65,"location":{"start":389,"end":398,"length":9}},{"text":"912803456","field":{"name":"US_BANK_NUMBER"},"score":0.05,"location":{"start":414,"end":423,"length":9}},{"text":"912803456","field":{"name":"US_PASSPORT"},"score":0.6,"location":{"start":414,"end":423,"length":9}},{"text":"912803456","field":{"name":"US_ITIN"},"score":0.3,"location":{"start":414,"end":423,"length":9}},{"text":"(212) 555-1234","field":{"name":"PHONE_NUMBER"},"score":1,"location":{"start":442,"end":456,"length":14}},{"text":"078-05-1120","field":{"name":"US_SSN"},"score":0.85,"location":{"start":486,"end":497,"length":11}},{"text":"cla.microsoft.com","field":{"name":"DOMAIN_NAME"},"score":1,"location":{"start":761,"end":778,"length":17}},{"text":"opencode@microsoft.com","field":{"name":"EMAIL_ADDRESS"},"score":1,"location":{"start":1193,"end":1215,"length":22}},{"text":"microsoft.com","field":{"name":"DOMAIN_NAME"},"score":1,"location":{"start":1202,"end":1215,"length":13}}]` + analyzeResults := []*types.AnalyzeResult{} + err := json.Unmarshal([]byte(analyzeResultsJSON), &analyzeResults) + if err != nil { + assert.Error(t, err) + } + + var anonymizeTemplateJSON = `{"fieldTypeTransformations":[{"fields":[{"name":"DOMAIN_NAME"}],"transformation":{"replaceValue":{"newValue":""}}},{"fields":[{"name":"PERSON"}],"transformation":{"replaceValue":{"newValue":""}}},{"fields":[{"name":"US_BANK_NUMBER"}],"transformation":{"replaceValue":{"newValue":""}}},{"fields":[{"name":"CRYPTO"}],"transformation":{"replaceValue":{"newValue":""}}},{"fields":[{"name":"EMAIL_ADDRESS"}],"transformation":{"replaceValue":{"newValue":""}}},{"fields":[{"name":"US_PASSPORT"}],"transformation":{"replaceValue":{"newValue":""}}},{"fields":[{"name":"DATE_TIME"}],"transformation":{"replaceValue":{"newValue":""}}},{"fields":[{"name":"IP_ADDRESS"}],"transformation":{"replaceValue":{"newValue":""}}},{"fields":[{"name":"NRP"}],"transformation":{"replaceValue":{"newValue":""}}},{"fields":[{"name":"UK_NHS"}],"transformation":{"replaceValue":{"newValue":""}}},{"fields":[{"name":"CREDIT_CARD"}],"transformation":{"replaceValue":{"newValue":""}}},{"fields":[{"name":"IBAN_CODE"}],"transformation":{"replaceValue":{"newValue":""}}},{"fields":[{"name":"LOCATION"}],"transformation":{"replaceValue":{"newValue":""}}},{"fields":[{"name":"PHONE_NUMBER"}],"transformation":{"replaceValue":{"newValue":""}}},{"fields":[{"name":"US_DRIVER_LICENSE"}],"transformation":{"replaceValue":{"newValue":""}}},{"fields":[{"name":"US_ITIN"}],"transformation":{"replaceValue":{"newValue":""}}},{"fields":[{"name":"US_SSN"}],"transformation":{"replaceValue":{"newValue":""}}}]}` + anonymizerTemplate := types.AnonymizeTemplate{} + err = json.Unmarshal([]byte(anonymizeTemplateJSON), &anonymizerTemplate) + if err != nil { + assert.Error(t, err) + } + + text := `Here are a few examples of entities we currently support: + + Credit card: 4095-2609-9393-4932 + Crypto wallet id: 16Yeky6GMjeNkAiNcBY7ZhrLoMSgg1BoyZ + DateTime: September 18 + Domain: microsoft.com + Email address: test@presidio.site + IBAN: IL150120690000003111111 + IP: 192.168.0.1 + Person name: David Johnson + + Bank account: 2854567876542 + Driver license number: H12234567 + Passport: 912803456 + Phone number: (212) 555-1234. + Social security number: 078-05-1120 + +This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com. +When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the +PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. + +This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact +opencode@microsoft.com with any additional questions or comments.` + + output, err := ApplyAnonymizerTemplate(text, analyzeResults, &anonymizerTemplate) + if err != nil { + assert.Error(t, err) + } + + expected := `Here are a few examples of entities we currently support: + + Credit card: + Crypto wallet id: + DateTime: + Domain: + Email address: + IBAN: + IP: + Person name: + + Bank account: + Driver license number: + Passport: + Phone number: . + Social security number: + +This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://. +When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the +PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. + +This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact + with any additional questions or comments.` + + assert.Equal(t, expected, output) +}