Context aware, pluggable and customizable data protection and de-identification SDK for text and images
Перейти к файлу
Sharon Hart b96af984c8
Run E2E Integration Tests on Deployment (#502)
* Run e2e integration tests after deployment

* Add stage name

* build

* Take from vars, bump

* rebase

* Change path

* retest

Co-authored-by: sharon <sharon.hart@microsoft.com>
2021-02-11 18:02:52 +02:00
.github Update CODEOWNERS 2021-01-21 11:09:54 +02:00
.pipelines/templates Run E2E Integration Tests on Deployment (#502) 2021-02-11 18:02:52 +02:00
docs Feature/languages doc (#498) 2021-02-11 14:22:08 +02:00
e2e-tests Run E2E Integration Tests on Deployment (#502) 2021-02-11 18:02:52 +02:00
presidio-analyzer Feature/languages doc (#498) 2021-02-11 14:22:08 +02:00
presidio-anonymizer anonymizer engine lite refactor (#488) 2021-02-10 16:04:03 +02:00
presidio-image-anonymizer v2 image anonymizer API (#501) 2021-02-11 16:54:35 +02:00
.gitignore disable VERSION 2021-01-20 16:48:41 +02:00
.pre-commit-config.yaml Rename 'functional-tests' to 'e2e-tests' (#480) 2021-02-07 11:57:09 +02:00
CONTRIBUTING.md Rename 'functional-tests' to 'e2e-tests' (#480) 2021-02-07 11:57:09 +02:00
LICENSE Initial presidio version 2018-10-10 23:51:43 +03:00
NOTICE added PyYaml to Pipfile and Pipfile.lock 2021-01-28 12:30:30 +02:00
README.MD updated readme image 2021-02-03 15:20:48 +02:00
SECURITY.MD Create SECURITY.MD (#217) 2019-09-09 12:57:15 +03:00
VERSION Run E2E Integration Tests on Deployment (#502) 2021-02-11 18:02:52 +02:00
azure-pipelines-ci.yml Deploy from Release Pipeline (#504) 2021-02-11 13:14:15 +02:00
azure-pipelines.yml Rename 'functional-tests' to 'e2e-tests' (#480) 2021-02-07 11:57:09 +02:00
docker-compose.yml image anonymizer starter dockerfile (#483) 2021-02-07 18:42:01 +02:00

README.MD

Presidio - Data Protection and Anonymization API

Context aware, pluggable and customizable PII anonymization service for text and images.


Build Status MIT license Release

What is Presidio

Presidio (Origin from Latin praesidium protection, garrison) helps to ensure sensitive data is properly managed and governed. It provides fast identification and anonymization modules for private entities in text such as credit card numbers, names, locations, social security numbers, bitcoin wallets, US phone numbers, financial data and more.

Goals

  • Allow organizations to preserve privacy in a simpler way by democratizing de-identification technologies and introducing transparency in decisions.
  • Embrace extensibility and customizability to a specific business need.
  • Facilitate both fully automated and semi-automated PII de-identification flows on multiple platforms.

Main features

  1. Predefined or custom PII recognizers leveraging Named Entity Recognition, regular expressions, rule based logic and checksum with relevant context in multiple languages.
  2. Options for connecting to external PII detection models.
  3. Multiple usage options, from Python or PySpark workloads through Docker to Kubernetes.
  4. Customizability in PII identification and anonymization.
  5. Module for redacting PII text in images.

⚠️ 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.

Demo

Try Presidio with your own data

Presidio demo gif

Installing Presidio

  1. Using pip
  2. Using Docker

Running Presidio

  1. Running Presidio via code
  2. Running Presidio as an HTTP service
  3. Setting up a development environment
  4. Perform PII identification using presidio-analyzer
  5. Perform PII anonymization using presidio-anonymizer
  6. Perform PII identification and anonymization in images using presidio-image-anonymizer
  7. Example deployments

Support

Contributing

For details on contributing to this repository, see the contributing guide.

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.