Skip to content

Encrypting sensitive data on demand #16

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.

Sign up for GitHub

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

Open
mahdiridho wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Encrypting sensitive data on demand #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,10 @@ const LOG_FORMAT = process.env.AWS_LAMBDA_LOG_FORMAT || 'Text'
const main = async (event, context) => {
try {
logger.setCorrelationId(context.awsRequestId)

// if we call this, logger will support for encryption by default for defined sensitive attributes
logger.setEncryptionKey('my-project-key')

logger.addContextKey({
handlerNamespace: 'multiply',
logFormat: LOG_FORMAT,
Expand All @@ -161,7 +165,7 @@ const main = async (event, context) => {
const result = await Promise.all(promises)
const end = new Date().getTime()


// 'factor' value will be encrypted by default when we already set encryption key
logger.info('Result', { result }, {}, ['factor'])

logger.metric('multiply', {
Expand Down Expand Up @@ -220,6 +224,12 @@ Retrieves the current _correlationId_. Useful when the correlationId needs to be
const correlationId = logger.getCorrelationId()
```
* __correlationId__ [string, mandatory]
### setEncryptionKey
Define the crypto key for encryption module.
```javascript
logger.setEncryptionKey(encryptKey)
```
* __encryptKey__ [string, mandatory]
### logInputEvent
Logs the object passed as argument when the environment variable _LOG\_EVENT_ is set to _"true"_. Generally used to conditionally log the incoming event, but it can be used for any other payload too.

Expand Down
Loading