Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thiagobarradas/jsonmasking
Replace fields in json, replacing by something, don't care if property is in depth objects. Very useful to replace passwords credit card number, etc.
https://github.com/thiagobarradas/jsonmasking
dotnet dotnet-core dotnet-standard extension hidden json mask masking newtonsoft remove replace utility wildcard
Last synced: 1 day ago
JSON representation
Replace fields in json, replacing by something, don't care if property is in depth objects. Very useful to replace passwords credit card number, etc.
- Host: GitHub
- URL: https://github.com/thiagobarradas/jsonmasking
- Owner: ThiagoBarradas
- License: mit
- Created: 2018-09-11T18:43:24.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-11T13:29:55.000Z (5 months ago)
- Last Synced: 2024-12-14T02:02:46.593Z (8 days ago)
- Topics: dotnet, dotnet-core, dotnet-standard, extension, hidden, json, mask, masking, newtonsoft, remove, replace, utility, wildcard
- Language: C#
- Size: 67.4 KB
- Stars: 174
- Watchers: 15
- Forks: 47
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://barradas.visualstudio.com/Contributions/_build/latest?definitionId=1&branchName=develop)
[](https://sonarcloud.io/dashboard?id=ThiagoBarradas_jsonmasking)
[](https://sonarcloud.io/dashboard?id=ThiagoBarradas_jsonmasking)
[](https://www.nuget.org/packages/JsonMasking/)
[](https://www.nuget.org/packages/JsonMasking/)
# Json Masking
Replace fields in json, replacing by something, don't care if property is in depth objects. Very useful to replace passwords, credit card number, etc.
This library matching insensitive values with field namespaces. You can use wildcard * to allow any char in pattern;
# Sample
```c#
- Completely masking some of the properties
var example = new
{
SomeValue = "Demo",
Password = "SomePasswordHere",
DepthObject = new
{
Password = "SomePasswordHere2",
Card = new
{
Number = "555500022223333"
}
},
CreditCardNumber = "5555000011112222",
Card = new
{
Number = "555500022223333"
}
};
var exampleAsString = JsonConvert.Serialize(example); // value must be a json string to masked
// note that password is only replaced when is in root path
var blacklist = new string[] { "password", "card.number", "*.card.number" "creditcardnumber" };
var mask = "******";
var maskedExampleAsString = exampleAsString.MaskFields(blacklist, mask);
Console.WriteLine(maskedExampleAsString);
```
Output
```json
{
"SomeValue" : "Demo",
"Password" : "******",
"DepthObject" : {
"Password" : "SomePasswordHere2",
"Card" : {
"Number" : "******"
}
},
"CreditCardNumber" : "******",
"Card" : {
"Number" : "******"
}
}
```
```c#
- Partially masking some of the properties
var example = new
{
SomeValue = "Demo",
Password = "SomePasswordHere",
DepthObject = new
{
Password = "SomePasswordHere2",
Card = new
{
Number = "555500022223333"
}
},
CreditCardNumber = "5555000011112222",
Card = new
{
Number = "555500022223333"
}
};
var blacklistPartial = new Dictionary>(StringComparer.OrdinalIgnoreCase) // The key is the property to be partially masked and the value is the function to be applied.
{
{ "*card.number", text => // Note that the property "*card.number" is also in the blacklist. If the property only exists in the blacklistPartial, it will not be masked.
Regex.Replace(
text,
@"(\d{4,5})[ -|]?(\d{3,6})[ -|]?(\d{3,5})[ -|]?(\d{3,4})",
match => $"{match.Value.Substring(0, 6)}*****{match.Value.Substring(match.Value.Length - 4, 4)}")
}
};
var exampleAsString = JsonConvert.Serialize(example); // The value must be a JSON string to be masked.
// Note that the password is only replaced when it is in the root path.
var blacklist = new string[] { "password", "*card.number", "creditcardnumber" };
var mask = "******";
var maskedExampleAsString = exampleAsString.MaskFields(blacklist, mask, blacklistPartial); // The blacklistPartial is optional. If provided, it will apply the mask only if the property is also in the blacklist.
Console.WriteLine(maskedExampleAsString);
```
Output
```json
{
"SomeValue" : "Demo",
"Password" : "******",
"DepthObject" : {
"Password" : "SomePasswordHere2",
"Card" : {
"Number" : "555500*****3333"
}
},
"CreditCardNumber" : "******",
"Card" : {
"Number" : "555500*****3333"
}
}
```
## Install via NuGet
```
PM> Install-Package JsonMasking
```
## How can I contribute?
Please, refer to [CONTRIBUTING](.github/CONTRIBUTING.md)
## Found something strange or need a new feature?
Open a new Issue following our issue template [ISSUE_TEMPLATE](.github/ISSUE_TEMPLATE.md)
## Changelog
See in [nuget version history](https://www.nuget.org/packages/JsonMasking)
## Did you like it? Please, make a donate :)
if you liked this project, please make a contribution and help to keep this and other initiatives, send me some Satochis.
BTC Wallet: `1G535x1rYdMo9CNdTGK3eG6XJddBHdaqfX`
