-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Force redact all & Redact by Default
- Loading branch information
Showing
5 changed files
with
241 additions
and
55 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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 |
|---|---|---|
| @@ -1,9 +1,10 @@ | ||
| import { RequestType, ResponseType } from './types'; | ||
| import { RequestType, ResponseType, ConfigType } from './types'; | ||
| import { | ||
| prepareData, | ||
| expandSensitiveKeySetForArrays, | ||
| redactValuesFromKeys | ||
| } from './utils'; | ||
| import { defaultConfig, SensitiveKeyActions, EndpointActions } from './constants'; | ||
| import { get as _get } from 'lodash'; | ||
|
|
||
| it('generates multiple sensitive key paths for an array', () => { | ||
|
|
@@ -34,13 +35,13 @@ it('generates multiple sensitive key paths for an array', () => { | |
| ] | ||
| } | ||
| }; | ||
| const sensitiveKeys = ['blog.posts[].title']; | ||
| const sensitiveKeys = [{ keyPath: 'blog.posts[].title', action: SensitiveKeyActions.REDACT}]; | ||
| expect(expandSensitiveKeySetForArrays(obj, sensitiveKeys)).toEqual([ | ||
| 'blog.posts[0].title', | ||
| 'blog.posts[1].title', | ||
| 'blog.posts[2].title', | ||
| 'blog.posts[3].title' | ||
| ]); | ||
| ].map((key) => ({ keyPath: key, action: SensitiveKeyActions.REDACT }))); | ||
| }); | ||
|
|
||
| it('generates multiple sensitive key paths for an object with nested arrays', () => { | ||
|
|
@@ -129,7 +130,7 @@ it('generates multiple sensitive key paths for an object with nested arrays', () | |
| ] | ||
| } | ||
| }; | ||
| const sensitiveKeys = ['blog.posts[].comments[].body']; | ||
| const sensitiveKeys = [{ keyPath: 'blog.posts[].comments[].body', action: SensitiveKeyActions.REDACT }]; | ||
| expect(expandSensitiveKeySetForArrays(obj, sensitiveKeys)).toEqual([ | ||
| 'blog.posts[0].comments[0].body', | ||
| 'blog.posts[0].comments[1].body', | ||
|
|
@@ -141,7 +142,7 @@ it('generates multiple sensitive key paths for an object with nested arrays', () | |
| 'blog.posts[2].comments[0].body', | ||
| 'blog.posts[2].comments[1].body', | ||
| 'blog.posts[3].comments[0].body' | ||
| ]); | ||
| ].map((key) => ({ keyPath: key, action: SensitiveKeyActions.REDACT }))); | ||
| }); | ||
|
|
||
| it('redacts values from keys with proper marshalling', () => { | ||
|
|
@@ -189,12 +190,13 @@ it('redacts values from keys with proper marshalling', () => { | |
| location: 'path', | ||
| regex: '/posts', | ||
| ignored: false, | ||
| sensitiveKeys: ['requestBody.posts[].title'] | ||
| sensitiveKeys: [{ keyPath: 'requestBody.posts[].title', action: SensitiveKeyActions.REDACT }] | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| const redactedObj = redactValuesFromKeys(obj, remoteConfig); | ||
| const config = { remoteConfig, ...defaultConfig } as ConfigType; | ||
| const redactedObj = redactValuesFromKeys(obj, config); | ||
| expect(_get(redactedObj, 'event.request.body.posts[0].title')).toBeNull(); | ||
| expect(redactedObj.sensitiveKeyMetadata[0]).toEqual({ | ||
| keyPath: 'requestBody.posts[0].title', | ||
|
|
@@ -306,12 +308,12 @@ it('redacts values from keys of nested array', () => { | |
| location: 'path', | ||
| regex: '/posts', | ||
| ignored: false, | ||
| sensitiveKeys: ['requestBody.posts[].comments[].body'] | ||
| sensitiveKeys: [{ keyPath: 'requestBody.posts[].comments[].body', action: SensitiveKeyActions.REDACT }] | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| const redactedObj = redactValuesFromKeys(obj, remoteConfig); | ||
| const config = { remoteConfig, ...defaultConfig } as ConfigType; | ||
| const redactedObj = redactValuesFromKeys(obj, config); | ||
| expect( | ||
| _get(redactedObj, 'event.request.body.posts[0].comments[0].body') | ||
| ).toBeNull(); | ||
|
|
@@ -346,12 +348,12 @@ it('will not blow up or redact anything if the sensitive key is bad', () => { | |
| location: 'path', | ||
| regex: '/posts', | ||
| ignored: false, | ||
| sensitiveKeys: ['request_body.posts[].title[]'] | ||
| sensitiveKeys: [{ keyPath: 'request_body.posts[].title[]', action: SensitiveKeyActions.REDACT }] | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| const redactedObj = redactValuesFromKeys(obj, remoteConfig); | ||
| const config = { remoteConfig, ...defaultConfig } as ConfigType; | ||
| const redactedObj = redactValuesFromKeys(obj, config); | ||
| expect(_get(redactedObj, 'event.request.body.name')).toBeTruthy(); | ||
| expect(redactedObj.sensitiveKeyMetadata.length).toEqual(0); | ||
| }); | ||
|
|
@@ -395,13 +397,130 @@ it('will prepare the data appropriately for posting to the server', () => { | |
| location: 'path', | ||
| regex: '/posts', | ||
| ignored: false, | ||
| sensitiveKeys: ['responseBody.user.email', 'requestBody.blogType.name'] | ||
| sensitiveKeys: [ | ||
| { keyPath: 'responseBody.user.email', action: SensitiveKeyActions.REDACT}, | ||
| { keyPath: 'requestBody.blogType.name', action: SensitiveKeyActions.REDACT} | ||
| ] | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| const events = prepareData([obj], remoteConfig); | ||
| const config = { remoteConfig, ...defaultConfig } as ConfigType; | ||
| const events = prepareData([obj], config); | ||
| expect(_get(events[0], 'response.body.user.email')).toBeFalsy(); | ||
| expect(_get(events[0], 'request.body.blogType.name')).toBeFalsy(); | ||
| expect(events[0].metadata.sensitiveKeys.length).toEqual(2); | ||
| }); | ||
|
|
||
| it('will force redact all keys if the config is set to do so', () => { | ||
| const MOCK_DATA_SERVER = 'http://localhost:3001'; | ||
| const obj = { | ||
| request: { | ||
| id: '', | ||
| headers: {}, | ||
| method: 'GET', | ||
| url: `${MOCK_DATA_SERVER}/posts`, | ||
| path: '/posts', | ||
| search: '', | ||
| requestedAt: new Date(), | ||
| body: { | ||
| blogType: { | ||
| name: 'My Blog' | ||
| } | ||
| } | ||
| }, | ||
| response: { | ||
| headers: {}, | ||
| status: 200, | ||
| statusText: 'OK', | ||
| respondedAt: new Date(), | ||
| body: { | ||
| name: 'My Blog', | ||
| user: { | ||
| name: 'John Doe', | ||
| email: '[email protected]' | ||
| }, | ||
| comments: [{ id: 7, comment: 'good blog'}, { id: 8, comment: 'bad blog'}] | ||
| } | ||
| } | ||
| }; | ||
| const remoteConfig = { | ||
| [new URL(MOCK_DATA_SERVER).hostname]: { | ||
| '/posts': { | ||
| location: 'path', | ||
| regex: '/posts', | ||
| ignored: false, | ||
| sensitiveKeys: [] | ||
| } | ||
| } | ||
| }; | ||
| const config = { remoteConfig, ...defaultConfig, forceRedactAll: true } as ConfigType; | ||
| const events = prepareData([obj], config); | ||
| expect(_get(events[0], 'request.body.blogType.name')).toBeFalsy(); | ||
| expect(_get(events[0], 'response.body.name')).toBeFalsy(); | ||
| expect(_get(events[0], 'response.body.user.name')).toBeFalsy(); | ||
| expect(_get(events[0], 'response.body.user.email')).toBeFalsy(); | ||
| expect(_get(events[0], 'response.body.comments[0].id')).toBeFalsy(); | ||
| expect(_get(events[0], 'response.body.comments[0].comment')).toBeFalsy(); | ||
| expect(_get(events[0], 'response.body.comments[1].id')).toBeFalsy(); | ||
| expect(_get(events[0], 'response.body.comments[1].comment')).toBeFalsy(); | ||
| expect(events[0].metadata.sensitiveKeys.length).toEqual(8); | ||
| }); | ||
|
|
||
| it('will redact by default if the config is set to do so', () => { | ||
| const MOCK_DATA_SERVER = 'http://localhost:3001'; | ||
| const obj = { | ||
| request: { | ||
| id: '', | ||
| headers: {}, | ||
| method: 'GET', | ||
| url: `${MOCK_DATA_SERVER}/posts`, | ||
| path: '/posts', | ||
| search: '', | ||
| requestedAt: new Date(), | ||
| body: { | ||
| blogType: { | ||
| name: 'My Blog' | ||
| } | ||
| } | ||
| }, | ||
| response: { | ||
| headers: {}, | ||
| status: 200, | ||
| statusText: 'OK', | ||
| respondedAt: new Date(), | ||
| body: { | ||
| name: 'My Blog', | ||
| user: { | ||
| name: 'John Doe', | ||
| email: '[email protected]' | ||
| }, | ||
| comments: [{ id: 7, comment: 'good blog'}, { id: 8, comment: 'bad blog'}] | ||
| } | ||
| } | ||
| }; | ||
| const remoteConfig = { | ||
| [new URL(MOCK_DATA_SERVER).hostname]: { | ||
| '/posts': { | ||
| location: 'path', | ||
| regex: '/posts', | ||
| ignored: false, | ||
| sensitiveKeys: [ | ||
| { keyPath: 'responseBody.user.email', action: SensitiveKeyActions.ALLOW }, | ||
| { keyPath: 'requestBody.blogType.name', action: SensitiveKeyActions.REDACT }, | ||
| { keyPath: 'responseBody.comments[].id', action: SensitiveKeyActions.ALLOW } | ||
| ] | ||
| } | ||
| } | ||
| }; | ||
| const config = { remoteConfig, ...defaultConfig, redactByDefault: true } as ConfigType; | ||
| const events = prepareData([obj], config); | ||
| expect(_get(events[0], 'request.body.blogType.name')).toBeFalsy(); | ||
| expect(_get(events[0], 'response.body.name')).toBeFalsy(); | ||
| expect(_get(events[0], 'response.body.user.name')).toBeFalsy(); | ||
| expect(_get(events[0], 'response.body.user.email')).toBeTruthy(); | ||
| expect(_get(events[0], 'response.body.comments[0].id')).toBeTruthy(); | ||
| expect(_get(events[0], 'response.body.comments[0].comment')).toBeFalsy(); | ||
| expect(_get(events[0], 'response.body.comments[1].id')).toBeTruthy(); | ||
| expect(_get(events[0], 'response.body.comments[1].comment')).toBeFalsy(); | ||
| expect(events[0].metadata.sensitiveKeys.length).toEqual(5); | ||
| }); | ||
Oops, something went wrong.