-
Notifications
You must be signed in to change notification settings - Fork 274
[Smart Hashing] Add smart hashing documentation in readme #2860
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
370240c
Add smart hashing documentation in readme
harsh-joshi99 6a51361
Update smart hashing documentation
harsh-joshi99 4b43e09
update heading
harsh-joshi99 6a526d9
update docs
harsh-joshi99 d748b39
Update smart hashing documentation
harsh-joshi99 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -960,6 +960,50 @@ There are a few subtle differences from the Fetch API which are meant to limit t | |
- some options and behaviors are not applicable to Node.js and will be ignored by `node-fetch`. See this list of [known differences](https://github.com/node-fetch/node-fetch/blob/1780f5ae89107ded4f232f43219ab0e548b0647c/docs/v2-LIMITS.md). | ||
- `method` will automatically get upcased for consistency. | ||
|
||
## Automatic Hashing Detection with `processHashing` | ||
|
||
Our popular segment Adtect destinations support [automatic hash detection](https://segment.com/docs/connections/destinations/#hashing) of personally identifyable information (PII). If your destination hashes PII data, we recommend you use the `processHashing` utility instead of `createHash` from `crypto` module. | ||
This utility automatically detects if a value is already hashed. It will only apply a hash if the value appears to be unhashed. | ||
|
||
The `processHashing` utility supports `md5`, `sha1`,`sha224`,`sha256`,`sha384` and`sha512` hashing algorithms. It can output digests in `hex` or `base64` format. | ||
|
||
**Note**: For empty or whitespace-only strings, the `processHashing` outputs an empty string instead of throwing an error like `createHash` hash module. | ||
|
||
### Example 1: Hashing an Email Address | ||
|
||
``` | ||
import { processHashing } from 'destination-actions/lib/hashing-utils' | ||
|
||
const email = ' [email protected] ' | ||
const hashedEmail = processHashing( | ||
email, | ||
'sha256', | ||
'hex', | ||
(value) => value.trim().toLowerCase() | ||
) | ||
|
||
console.log(hashedEmail) // hashed string | ||
``` | ||
|
||
### Example 2: Hashing a Phone Number | ||
|
||
``` | ||
const phone = '+1(706)-767-5127' | ||
const normalizePhone = (value: string) => value.replace(/[^0-9]/g, '') | ||
|
||
const hashedPhone = processHashing( | ||
phone, | ||
'sha256', | ||
'hex', | ||
normalizePhone | ||
) | ||
|
||
console.log(hashedPhone) // hashed string | ||
``` | ||
|
||
**Requesting Additional Algorithms** | ||
To request additional hash algorithms, contact [email protected]. | ||
|
||
## Support | ||
|
||
For any issues, please contact our support team at [email protected]. | ||
|
@@ -991,3 +1035,7 @@ SOFTWARE. | |
## Contributing | ||
|
||
All third party contributors acknowledge that any contributions they provide will be made under the same open source license that the open source project is provided under. | ||
|
||
``` | ||
|
||
``` | ||
harsh-joshi99 marked this conversation as resolved.
Show resolved
Hide resolved
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.