Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kentico-ericd/xperience-community-database-anonymizer
Encrypts and decrypts sensitive data in Kentico 13 databases
https://github.com/kentico-ericd/xperience-community-database-anonymizer
kentico kentico-xperience security
Last synced: 15 days ago
JSON representation
Encrypts and decrypts sensitive data in Kentico 13 databases
- Host: GitHub
- URL: https://github.com/kentico-ericd/xperience-community-database-anonymizer
- Owner: kentico-ericd
- License: mit
- Created: 2025-01-14T18:35:28.000Z (22 days ago)
- Default Branch: main
- Last Pushed: 2025-01-16T19:38:16.000Z (20 days ago)
- Last Synced: 2025-01-16T20:42:38.449Z (20 days ago)
- Topics: kentico, kentico-xperience, security
- Language: C#
- Homepage:
- Size: 47.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Xperience Community: Database Anonymizer
[](https://github.com/Kentico/.github/blob/main/SUPPORT.md#labs-limited-support)
[](https://github.com/kentico-ericd/xperience-community-database-anonymizer/actions/workflows/build.yml)
## Description
This Kentico 13 integration allows developers to encrypt sensitive data within the Kentico database using a salt of their choosing. The data can only be decrypted using this salt, so the database can be shared with members outside of the organization safely. Once a backup of the database with anonymized data is created, the original database can be decrypted to restore the sensitive data.
## Requirements
### Library Version Matrix
| Xperience Version | Library Version |
| ----------------- | --------------- |
| >= 13.0.0 | >= 1.0.0 |
## Package Installation
Add the package to your CMS application using Visual Studio's [Package Manager](https://learn.microsoft.com/en-us/nuget/consume-packages/install-use-packages-visual-studio) or [NuGet CLI](https://learn.microsoft.com/en-us/nuget/consume-packages/install-use-packages-powershell):
```powershell
Install-Package Xperience.Community.DatabaseAnonymizer
```
## Quick Start
> :warning: Always make a backup of your database _before_ running anonymization!
The anonymization/deanonymization process will _only_ run if there are two application settings present in the CMS project's `web.config`:
```xml
```
Add these keys to your `web.config` with the desired salt, and upon the next application start, the database will be anonymized. A new settings key (installed automatically) named "XperienceCommunityDatabaseAnonymized" tracks the current state of the database, so it is safe to leave these keys in the `web.config`- the process will only run once.
The anonymization process runs in the background on application start. To monitor its progress, check the __Event log__ for "ANONYMIZE_START" and "ANONYMIZE_END" events (or, the equivalent "DEANONYMIZE" events). The "END" event will contain a detailed description of the process and modified records. To restore the database to its original state, set the "XperienceCommunityEnableAnonymization" key to false. If you are shipping the entire project (not just the sanitized database), be sure to remove the salt from the `web.config`!
## Full Instructions
View the [Usage Guide](./docs/Usage-Guide.md) for more detailed instructions.
## Contributing
To see the guidelines for Contributing to Kentico open source software, please see [Kentico's `CONTRIBUTING.md`](https://github.com/Kentico/.github/blob/main/CONTRIBUTING.md) for more information and follow the [Kentico's `CODE_OF_CONDUCT`](https://github.com/Kentico/.github/blob/main/CODE_OF_CONDUCT.md).
## License
Distributed under the MIT License. See [`LICENSE.md`](./LICENSE.md) for more information.
## Support
[](https://github.com/Kentico/.github/blob/main/SUPPORT.md#labs-limited-support)
This project has **Kentico Labs limited support**.
See [`SUPPORT.md`](https://github.com/Kentico/.github/blob/main/SUPPORT.md#full-support) for more information.
For any security issues see [`SECURITY.md`](https://github.com/Kentico/.github/blob/main/SECURITY.md).