updates docs for supported masking strategies and associated configs #173
Conversation
| ## Configuration | ||
|
|
||
| Only null value masking is currently supported by fidesops policies, but support for other strategies is coming. | ||
| Currently, erasure requests will replace customer data with null values. | ||
| Erasure requests will replace mask data with the chosen masking strategy. |
There was a problem hiding this comment.
I think we meant to remove either mask or replace in this line?
|
|
||
| ### Hash | ||
|
|
||
| Masks the input value by returning a hashed version of the input value. Is deterministic such that the same input value will mask to the same value within the same privacy request. This is not the case when the masking service is called as standalone service (outside of a privacy request). |
There was a problem hiding this comment.
Consider:
Masks the data by hashing the input before returning it. The hash is deterministic such that the same input will return the same output within the context of the same privacy request. This is not the case when the masking service is called as a standalone service, outside the context of a privacy request.
|
|
||
| ### AES Encrypt | ||
|
|
||
| Masks by encrypting the value using AES. Is deterministic such that the same input value will mask to the same value within the same privacy request. This is not the case when the masking service is called as standalone service (outside of a privacy request). |
There was a problem hiding this comment.
As above for deterministic explanation
|
|
||
| ### HMAC | ||
|
|
||
| Masks the input value by using the HMAC algorithm along with a hashed version of the data and a secret key. Is deterministic such that the same input value will mask to the same value within the same privacy request. This is not the case when the masking service is called as standalone service (outside of a privacy request). |
There was a problem hiding this comment.
As above for deterministic explanation
There was a problem hiding this comment.
A few small language tweaks but a very useful addition nonetheless, thanks @eastandwestwind
|
@seanpreston thanks for the comments! I've made those updates |
…173) * updates docs for supported masking strategies and associated configs * formatting to make each masking strategy more obvious * missed a spot * cr changes
Purpose
Update docs to reflect current supported masking strategies
Changes
masking_strategies.md. Screenshot of page for ease of review:Checklist
Ticket
Fixes #155