Skip to content
Navigation Menu
{{ message }}
forked from GoogleCloudPlatform/python-docs-samples
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdeid.py
More file actions
584 lines (522 loc) · 22.7 KB
/
Copy pathdeid.py
File metadata and controls
584 lines (522 loc) · 22.7 KB
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
# Copyright 2017 Google Inc.
#
# 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.
"""Uses of the Data Loss Prevention API for deidentifying sensitive data."""
from __future__ import print_function
import argparse
# [START dlp_deidentify_masking]
def deidentify_with_mask(project, string, info_types, masking_character=None,
number_to_mask=0):
"""Uses the Data Loss Prevention API to deidentify sensitive data in a
string by masking it with a character.
Args:
project: The Google Cloud project id to use as a parent resource.
item: The string to deidentify (will be treated as text).
masking_character: The character to mask matching sensitive data with.
number_to_mask: The maximum number of sensitive characters to mask in
a match. If omitted or set to zero, the API will default to no
maximum.
Returns:
None; the response from the API is printed to the terminal.
"""
# Import the client library
import google.cloud.dlp
# Instantiate a client
dlp = google.cloud.dlp.DlpServiceClient()
# Convert the project id into a full resource id.
parent = dlp.project_path(project)
# Construct inspect configuration dictionary
inspect_config = {
'info_types': [{'name': info_type} for info_type in info_types]
}
# Construct deidentify configuration dictionary
deidentify_config = {
'info_type_transformations': {
'transformations': [
{
'primitive_transformation': {
'character_mask_config': {
'masking_character': masking_character,
'number_to_mask': number_to_mask
}
}
}
]
}
}
# Construct item
item = {'value': string}
# Call the API
response = dlp.deidentify_content(
parent, inspect_config=inspect_config,
deidentify_config=deidentify_config, item=item)
# Print out the results.
print(response.item.value)
# [END dlp_deidentify_masking]
# [START dlp_deidentify_fpe]
def deidentify_with_fpe(project, string, info_types, alphabet=None,
surrogate_type=None, key_name=None, wrapped_key=None):
"""Uses the Data Loss Prevention API to deidentify sensitive data in a
string using Format Preserving Encryption (FPE).
Args:
project: The Google Cloud project id to use as a parent resource.
item: The string to deidentify (will be treated as text).
alphabet: The set of characters to replace sensitive ones with. For
more information, see https://cloud.google.com/dlp/docs/reference/
rest/v2beta2/organizations.deidentifyTemplates#ffxcommonnativealphabet
surrogate_type: The name of the surrogate custom info type to use. Only
necessary if you want to reverse the deidentification process. Can
be essentially any arbitrary string, as long as it doesn't appear
in your dataset otherwise.
key_name: The name of the Cloud KMS key used to encrypt ('wrap') the
AES-256 key. Example:
key_name = 'projects/YOUR_GCLOUD_PROJECT/locations/YOUR_LOCATION/
keyRings/YOUR_KEYRING_NAME/cryptoKeys/YOUR_KEY_NAME'
wrapped_key: The encrypted ('wrapped') AES-256 key to use. This key
should be encrypted using the Cloud KMS key specified by key_name.
Returns:
None; the response from the API is printed to the terminal.
"""
# Import the client library
import google.cloud.dlp
# Instantiate a client
dlp = google.cloud.dlp.DlpServiceClient()
# Convert the project id into a full resource id.
parent = dlp.project_path(project)
# The wrapped key is base64-encoded, but the library expects a binary
# string, so decode it here.
import base64
wrapped_key = base64.b64decode(wrapped_key)
# Construct FPE configuration dictionary
crypto_replace_ffx_fpe_config = {
'crypto_key': {
'kms_wrapped': {
'wrapped_key': wrapped_key,
'crypto_key_name': key_name
}
},
'common_alphabet': alphabet
}
# Add surrogate type
if surrogate_type:
crypto_replace_ffx_fpe_config['surrogate_info_type'] = {
'name': surrogate_type
}
# Construct inspect configuration dictionary
inspect_config = {
'info_types': [{'name': info_type} for info_type in info_types]
}
# Construct deidentify configuration dictionary
deidentify_config = {
'info_type_transformations': {
'transformations': [
{
'primitive_transformation': {
'crypto_replace_ffx_fpe_config':
crypto_replace_ffx_fpe_config
}
}
]
}
}
# Convert string to item
item = {'value': string}
# Call the API
response = dlp.deidentify_content(
parent, inspect_config=inspect_config,
deidentify_config=deidentify_config, item=item)
# Print results
print(response.item.value)
# [END dlp_deidentify_fpe]
# [START dlp_reidentify_fpe]
def reidentify_with_fpe(project, string, alphabet=None,
surrogate_type=None, key_name=None, wrapped_key=None):
"""Uses the Data Loss Prevention API to reidentify sensitive data in a
string that was encrypted by Format Preserving Encryption (FPE).
Args:
project: The Google Cloud project id to use as a parent resource.
item: The string to deidentify (will be treated as text).
alphabet: The set of characters to replace sensitive ones with. For
more information, see https://cloud.google.com/dlp/docs/reference/
rest/v2beta2/organizations.deidentifyTemplates#ffxcommonnativealphabet
surrogate_type: The name of the surrogate custom info type to used
during the encryption process.
key_name: The name of the Cloud KMS key used to encrypt ('wrap') the
AES-256 key. Example:
keyName = 'projects/YOUR_GCLOUD_PROJECT/locations/YOUR_LOCATION/
keyRings/YOUR_KEYRING_NAME/cryptoKeys/YOUR_KEY_NAME'
wrapped_key: The encrypted ('wrapped') AES-256 key to use. This key
should be encrypted using the Cloud KMS key specified by key_name.
Returns:
None; the response from the API is printed to the terminal.
"""
# Import the client library
import google.cloud.dlp
# Instantiate a client
dlp = google.cloud.dlp.DlpServiceClient()
# Convert the project id into a full resource id.
parent = dlp.project_path(project)
# The wrapped key is base64-encoded, but the library expects a binary
# string, so decode it here.
import base64
wrapped_key = base64.b64decode(wrapped_key)
# Construct Deidentify Config
reidentify_config = {
'info_type_transformations': {
'transformations': [
{
'primitive_transformation': {
'crypto_replace_ffx_fpe_config': {
'crypto_key': {
'kms_wrapped': {
'wrapped_key': wrapped_key,
'crypto_key_name': key_name
}
},
'common_alphabet': alphabet,
'surrogate_info_type': {
'name': surrogate_type
}
}
}
}
]
}
}
inspect_config = {
'custom_info_types': [
{
'info_type': {
'name': surrogate_type
},
'surrogate_type': {
}
}
]
}
# Convert string to item
item = {'value': string}
# Call the API
response = dlp.reidentify_content(
parent,
inspect_config=inspect_config,
reidentify_config=reidentify_config,
item=item)
# Print results
print(response.item.value)
# [END dlp_reidentify_fpe]
# [START dlp_deidentify_date_shift]
def deidentify_with_date_shift(project, input_csv_file=None,
output_csv_file=None, date_fields=None,
lower_bound_days=None, upper_bound_days=None,
context_field_id=None, wrapped_key=None,
key_name=None):
"""Uses the Data Loss Prevention API to deidentify dates in a CSV file by
pseudorandomly shifting them.
Args:
project: The Google Cloud project id to use as a parent resource.
input_csv_file: The path to the CSV file to deidentify. The first row
of the file must specify column names, and all other rows must
contain valid values.
output_csv_file: The path to save the date-shifted CSV file.
date_fields: The list of (date) fields in the CSV file to date shift.
Example: ['birth_date', 'register_date']
lower_bound_days: The maximum number of days to shift a date backward
upper_bound_days: The maximum number of days to shift a date forward
context_field_id: (Optional) The column to determine date shift amount
based on. If this is not specified, a random shift amount will be
used for every row. If this is specified, then 'wrappedKey' and
'keyName' must also be set. Example:
contextFieldId = [{ 'name': 'user_id' }]
key_name: (Optional) The name of the Cloud KMS key used to encrypt
('wrap') the AES-256 key. Example:
key_name = 'projects/YOUR_GCLOUD_PROJECT/locations/YOUR_LOCATION/
keyRings/YOUR_KEYRING_NAME/cryptoKeys/YOUR_KEY_NAME'
wrapped_key: (Optional) The encrypted ('wrapped') AES-256 key to use.
This key should be encrypted using the Cloud KMS key specified by
key_name.
Returns:
None; the response from the API is printed to the terminal.
"""
# Import the client library
import google.cloud.dlp
# Instantiate a client
dlp = google.cloud.dlp.DlpServiceClient()
# Convert the project id into a full resource id.
parent = dlp.project_path(project)
# Convert date field list to Protobuf type
def map_fields(field):
return {'name': field}
if date_fields:
date_fields = map(map_fields, date_fields)
else:
date_fields = []
# Read and parse the CSV file
import csv
from datetime import datetime
f = []
with open(input_csv_file, 'r') as csvfile:
reader = csv.reader(csvfile)
for row in reader:
f.append(row)
# Helper function for converting CSV rows to Protobuf types
def map_headers(header):
return {'name': header}
def map_data(value):
try:
date = datetime.strptime(value, '%m/%d/%Y')
return {
'date_value': {
'year': date.year,
'month': date.month,
'day': date.day
}
}
except ValueError:
return {'string_value': value}
def map_rows(row):
return {'values': map(map_data, row)}
# Using the helper functions, convert CSV rows to protobuf-compatible
# dictionaries.
csv_headers = map(map_headers, f[0])
csv_rows = map(map_rows, f[1:])
# Construct the table dict
table_item = {
'table': {
'headers': csv_headers,
'rows': csv_rows
}
}
# Construct date shift config
date_shift_config = {
'lower_bound_days': lower_bound_days,
'upper_bound_days': upper_bound_days
}
# If using a Cloud KMS key, add it to the date_shift_config.
# The wrapped key is base64-encoded, but the library expects a binary
# string, so decode it here.
if context_field_id and key_name and wrapped_key:
import base64
date_shift_config['context'] = {'name': context_field_id}
date_shift_config['crypto_key'] = {
'kms_wrapped': {
'wrapped_key': base64.b64decode(wrapped_key),
'crypto_key_name': key_name
}
}
elif context_field_id or key_name or wrapped_key:
raise ValueError("""You must set either ALL or NONE of
[context_field_id, key_name, wrapped_key]!""")
# Construct Deidentify Config
deidentify_config = {
'record_transformations': {
'field_transformations': [
{
'fields': date_fields,
'primitive_transformation': {
'date_shift_config': date_shift_config
}
}
]
}
}
# Write to CSV helper methods
def write_header(header):
return header.name
def write_data(data):
return data.string_value or '%s/%s/%s' % (data.date_value.month,
data.date_value.day,
data.date_value.year)
# Call the API
response = dlp.deidentify_content(
parent, deidentify_config=deidentify_config, item=table_item)
# Write results to CSV file
with open(output_csv_file, 'w') as csvfile:
write_file = csv.writer(csvfile, delimiter=',')
write_file.writerow(map(write_header, response.item.table.headers))
for row in response.item.table.rows:
write_file.writerow(map(write_data, row.values))
# Print status
print('Successfully saved date-shift output to {}'.format(
output_csv_file))
# [END dlp_deidentify_date_shift]
if __name__ == '__main__':
parser = argparse.ArgumentParser(description=__doc__)
subparsers = parser.add_subparsers(
dest='content', help='Select how to submit content to the API.')
subparsers.required = True
mask_parser = subparsers.add_parser(
'deid_mask',
help='Deidentify sensitive data in a string by masking it with a '
'character.')
mask_parser.add_argument(
'--info_types', nargs='+',
help='Strings representing info types to look for. A full list of '
'info categories and types is available from the API. Examples '
'include "FIRST_NAME", "LAST_NAME", "EMAIL_ADDRESS". '
'If unspecified, the three above examples will be used.',
default=['FIRST_NAME', 'LAST_NAME', 'EMAIL_ADDRESS'])
mask_parser.add_argument(
'project',
help='The Google Cloud project id to use as a parent resource.')
mask_parser.add_argument('item', help='The string to deidentify.')
mask_parser.add_argument(
'-n', '--number_to_mask',
type=int,
default=0,
help='The maximum number of sensitive characters to mask in a match. '
'If omitted the request or set to 0, the API will mask any mathcing '
'characters.')
mask_parser.add_argument(
'-m', '--masking_character',
help='The character to mask matching sensitive data with.')
fpe_parser = subparsers.add_parser(
'deid_fpe',
help='Deidentify sensitive data in a string using Format Preserving '
'Encryption (FPE).')
fpe_parser.add_argument(
'--info_types', action='append',
help='Strings representing info types to look for. A full list of '
'info categories and types is available from the API. Examples '
'include "FIRST_NAME", "LAST_NAME", "EMAIL_ADDRESS". '
'If unspecified, the three above examples will be used.',
default=['FIRST_NAME', 'LAST_NAME', 'EMAIL_ADDRESS'])
fpe_parser.add_argument(
'project',
help='The Google Cloud project id to use as a parent resource.')
fpe_parser.add_argument(
'item',
help='The string to deidentify. '
'Example: string = \'My SSN is 372819127\'')
fpe_parser.add_argument(
'key_name',
help='The name of the Cloud KMS key used to encrypt (\'wrap\') the '
'AES-256 key. Example: '
'key_name = \'projects/YOUR_GCLOUD_PROJECT/locations/YOUR_LOCATION/'
'keyRings/YOUR_KEYRING_NAME/cryptoKeys/YOUR_KEY_NAME\'')
fpe_parser.add_argument(
'wrapped_key',
help='The encrypted (\'wrapped\') AES-256 key to use. This key should '
'be encrypted using the Cloud KMS key specified by key_name.')
fpe_parser.add_argument(
'-a', '--alphabet', default='ALPHA_NUMERIC',
help='The set of characters to replace sensitive ones with. Commonly '
'used subsets of the alphabet include "NUMERIC", "HEXADECIMAL", '
'"UPPER_CASE_ALPHA_NUMERIC", "ALPHA_NUMERIC", '
'"FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED"')
fpe_parser.add_argument(
'-s', '--surrogate_type',
help='The name of the surrogate custom info type to use. Only '
'necessary if you want to reverse the deidentification process. Can '
'be essentially any arbitrary string, as long as it doesn\'t appear '
'in your dataset otherwise.')
reid_parser = subparsers.add_parser(
'reid_fpe',
help='Reidentify sensitive data in a string using Format Preserving '
'Encryption (FPE).')
reid_parser.add_argument(
'project',
help='The Google Cloud project id to use as a parent resource.')
reid_parser.add_argument(
'item',
help='The string to deidentify. '
'Example: string = \'My SSN is 372819127\'')
reid_parser.add_argument(
'surrogate_type',
help='The name of the surrogate custom info type to use. Only '
'necessary if you want to reverse the deidentification process. Can '
'be essentially any arbitrary string, as long as it doesn\'t appear '
'in your dataset otherwise.')
reid_parser.add_argument(
'key_name',
help='The name of the Cloud KMS key used to encrypt (\'wrap\') the '
'AES-256 key. Example: '
'key_name = \'projects/YOUR_GCLOUD_PROJECT/locations/YOUR_LOCATION/'
'keyRings/YOUR_KEYRING_NAME/cryptoKeys/YOUR_KEY_NAME\'')
reid_parser.add_argument(
'wrapped_key',
help='The encrypted (\'wrapped\') AES-256 key to use. This key should '
'be encrypted using the Cloud KMS key specified by key_name.')
reid_parser.add_argument(
'-a', '--alphabet', default='ALPHA_NUMERIC',
help='The set of characters to replace sensitive ones with. Commonly '
'used subsets of the alphabet include "NUMERIC", "HEXADECIMAL", '
'"UPPER_CASE_ALPHA_NUMERIC", "ALPHA_NUMERIC", '
'"FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED"')
date_shift_parser = subparsers.add_parser(
'deid_date_shift',
help='Deidentify dates in a CSV file by pseudorandomly shifting them.')
date_shift_parser.add_argument(
'project',
help='The Google Cloud project id to use as a parent resource.')
date_shift_parser.add_argument(
'input_csv_file',
help='The path to the CSV file to deidentify. The first row of the '
'file must specify column names, and all other rows must contain '
'valid values.')
date_shift_parser.add_argument(
'output_csv_file',
help='The path to save the date-shifted CSV file.')
date_shift_parser.add_argument(
'lower_bound_days', type=int,
help='The maximum number of days to shift a date backward')
date_shift_parser.add_argument(
'upper_bound_days', type=int,
help='The maximum number of days to shift a date forward')
date_shift_parser.add_argument(
'date_fields', nargs='+',
help='The list of date fields in the CSV file to date shift. Example: '
'[\'birth_date\', \'register_date\']')
date_shift_parser.add_argument(
'--context_field_id',
help='(Optional) The column to determine date shift amount based on. '
'If this is not specified, a random shift amount will be used for '
'every row. If this is specified, then \'wrappedKey\' and \'keyName\' '
'must also be set.')
date_shift_parser.add_argument(
'--key_name',
help='(Optional) The name of the Cloud KMS key used to encrypt '
'(\'wrap\') the AES-256 key. Example: '
'key_name = \'projects/YOUR_GCLOUD_PROJECT/locations/YOUR_LOCATION/'
'keyRings/YOUR_KEYRING_NAME/cryptoKeys/YOUR_KEY_NAME\'')
date_shift_parser.add_argument(
'--wrapped_key',
help='(Optional) The encrypted (\'wrapped\') AES-256 key to use. This '
'key should be encrypted using the Cloud KMS key specified by'
'key_name.')
args = parser.parse_args()
if args.content == 'deid_mask':
deidentify_with_mask(args.project, args.item, args.info_types,
masking_character=args.masking_character,
number_to_mask=args.number_to_mask)
elif args.content == 'deid_fpe':
deidentify_with_fpe(args.project, args.item, args.info_types,
alphabet=args.alphabet,
wrapped_key=args.wrapped_key,
key_name=args.key_name,
surrogate_type=args.surrogate_type)
elif args.content == 'reid_fpe':
reidentify_with_fpe(args.project, args.item,
surrogate_type=args.surrogate_type,
wrapped_key=args.wrapped_key,
key_name=args.key_name, alphabet=args.alphabet)
elif args.content == 'deid_date_shift':
deidentify_with_date_shift(args.project,
input_csv_file=args.input_csv_file,
output_csv_file=args.output_csv_file,
lower_bound_days=args.lower_bound_days,
upper_bound_days=args.upper_bound_days,
date_fields=args.date_fields,
context_field_id=args.context_field_id,
wrapped_key=args.wrapped_key,
key_name=args.key_name)
You can’t perform that action at this time.