/
inspectStringWithExclusionDict.js
127 lines (107 loc) · 3.75 KB
/
inspectStringWithExclusionDict.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
'use strict';
// sample-metadata:
// title: Inspects strings omit overlapping.
// description: Inspect a string for sensitive data excluding a list of words.
// usage: node inspectStringWithExclusionDict.js my-project string infoTypes excludedWords
function main(projectId, string, infoTypes, excludedWords) {
[infoTypes, excludedWords] = transformCLI(infoTypes, excludedWords);
// [START dlp_inspect_string_with_exclusion_dict]
// Imports the Google Cloud Data Loss Prevention library
const DLP = require('@google-cloud/dlp');
// Instantiates a client
const dlp = new DLP.DlpServiceClient();
// The project ID to run the API call under
// const projectId = 'my-project';
// The string to inspect
// const string = 'Some email addresses: gary@example.com, example@example.com';
// The infoTypes of information to match
// const infoTypes = [{ name: 'EMAIL_ADDRESS' }];
// Words to exclude
// const excludedWords = ['gary@example.com'];
async function inspectStringWithExclusionDict() {
// Specify the type and content to be inspected.
const item = {
byteItem: {
type: DLP.protos.google.privacy.dlp.v2.ByteContentItem.BytesType
.TEXT_UTF8,
data: Buffer.from(string, 'utf-8'),
},
};
// Exclude matches from the specified excludedWords.
const exclusionRule = {
dictionary: {
wordList: {
words: excludedWords,
},
},
matchingType:
DLP.protos.google.privacy.dlp.v2.MatchingType.MATCHING_TYPE_FULL_MATCH,
};
// Construct a ruleset that applies the exclusion rule to the specified infotype.
const ruleSet = [
{
infoTypes: infoTypes,
rules: [
{
exclusionRule: exclusionRule,
},
],
},
];
// Construct the configuration for the Inspect request, including the ruleset.
const inspectConfig = {
infoTypes: infoTypes,
ruleSet: ruleSet,
includeQuote: true,
};
// Construct the Inspect request to be sent by the client.
const request = {
parent: `projects/${projectId}/locations/global`,
inspectConfig: inspectConfig,
item: item,
};
// Use the client to send the API request.
const [response] = await dlp.inspectContent(request);
// Print Findings
const findings = response.result.findings;
if (findings.length > 0) {
console.log(`Findings: ${findings.length}\n`);
findings.forEach(finding => {
console.log(`InfoType: ${finding.infoType.name}`);
console.log(`\tQuote: ${finding.quote}`);
console.log(`\tLikelihood: ${finding.likelihood} \n`);
});
} else {
console.log('No findings.');
}
}
inspectStringWithExclusionDict();
// [END dlp_inspect_string_with_exclusion_dict]
}
process.on('unhandledRejection', err => {
console.error(err.message);
process.exitCode = 1;
});
main(...process.argv.slice(2));
function transformCLI(infoTypes, excludedWords) {
infoTypes = infoTypes
? infoTypes.split(',').map(type => {
return {name: type};
})
: undefined;
excludedWords = excludedWords ? excludedWords.split(',') : [];
return [infoTypes, excludedWords];
}