Add new DLP samples (Bigquery, DeID, Risk Analysis) #841
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,237 @@ | ||
| /** | ||
| * Copyright 2017 Google Inc. | ||
| * <p> | ||
| * 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 | ||
| * <p> | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * <p> | ||
| * 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. | ||
| */ | ||
|
|
||
| package com.example.dlp; | ||
|
|
||
| import com.google.cloud.dlp.v2beta1.DlpServiceClient; | ||
| import com.google.common.io.BaseEncoding; | ||
| import com.google.privacy.dlp.v2beta1.*; | ||
| import com.google.privacy.dlp.v2beta1.InfoTypeTransformations.InfoTypeTransformation; | ||
| import com.google.privacy.dlp.v2beta1.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet; | ||
| import com.google.protobuf.ByteString; | ||
| import org.apache.commons.cli.*; | ||
|
|
||
|
|
||
| public class DeId { | ||
|
There was a problem hiding this comment. Given this short name, I recommend renaming to DeIdentification |
||
|
|
||
| private static void deidentifyWithMask(String string, Character maskingCharacter, int numberToMask) { | ||
|
|
||
| // [START dlp_deidentify_mask] | ||
| // instantiate a client | ||
| try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) { | ||
|
|
||
| // The string to deidentify | ||
| // string = "My SSN is 372819127"; | ||
|
|
||
| // (Optional) The maximum number of sensitive characters to mask in a match | ||
| // If omitted from the request or set to 0, the API will mask any matching characters | ||
| // numberToMask = 5; | ||
|
|
||
| // (Optional) The character to mask matching sensitive data with | ||
| // maskingCharacter = 'x'; | ||
|
|
||
| ContentItem contentItem = | ||
| ContentItem.newBuilder() | ||
| .setType("text/plain") | ||
| .setValue(string) | ||
| .build(); | ||
|
|
||
| CharacterMaskConfig characterMaskConfig = | ||
| CharacterMaskConfig.newBuilder() | ||
| .setMaskingCharacter(maskingCharacter.toString()) | ||
| .setNumberToMask(numberToMask) | ||
| .build(); | ||
|
|
||
| PrimitiveTransformation primitiveTransformation = | ||
| PrimitiveTransformation.newBuilder() | ||
| .setCharacterMaskConfig(characterMaskConfig) | ||
| .build(); | ||
|
|
||
| InfoTypeTransformation infoTypeTransformationObject = | ||
| InfoTypeTransformation.newBuilder() | ||
| .setPrimitiveTransformation(primitiveTransformation) | ||
| .build(); | ||
|
|
||
| InfoTypeTransformations infoTypeTransformationArray = | ||
|
There was a problem hiding this comment. Given all these objects that get created just to create a request, it would be to provide a comment above each to state what it is. It is unfortunate that There was a problem hiding this comment. I had similar comments with the Node client libraries, to be honest. I'll follow up with the API/product team(s) about this. (TODO, so I can CTRL-F for this comment.) |
||
| InfoTypeTransformations.newBuilder() | ||
| .addTransformations(infoTypeTransformationObject) | ||
| .build(); | ||
|
|
||
| DeidentifyConfig deidentifyConfig = | ||
| DeidentifyConfig.newBuilder() | ||
| .setInfoTypeTransformations(infoTypeTransformationArray) | ||
| .build(); | ||
|
|
||
| DeidentifyContentRequest request = | ||
| DeidentifyContentRequest.newBuilder() | ||
| .setDeidentifyConfig(deidentifyConfig) | ||
| .addItems(contentItem) | ||
| .build(); | ||
|
|
||
| DeidentifyContentResponse response = dlpServiceClient.deidentifyContent(request); | ||
|
|
||
| for (ContentItem item : response.getItemsList()) { | ||
| System.out.println(item.getValue()); | ||
|
There was a problem hiding this comment. and example would be useful as a comment on what to expect. |
||
| } | ||
| } catch (Exception e) { | ||
| System.out.println("Error in deidentifyWithMask: " + e.getMessage()); | ||
| } | ||
| // [END dlp_deidentify_mask] | ||
| } | ||
|
|
||
| private static void deidentifyWithFpe( | ||
| String string, CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet alphabet, String keyName, String wrappedKey) { | ||
|
There was a problem hiding this comment. given the import, is There was a problem hiding this comment. Done - removed the prefix. |
||
| // [START dlp_deidentify_fpe] | ||
| // instantiate a client | ||
| try (DlpServiceClient dlpServiceClient = DlpServiceClient.create()) { | ||
|
|
||
| // The string to deidentify | ||
| // string = "My SSN is 372819127"; | ||
|
|
||
| // The set of characters to replace sensitive ones with | ||
| // For more information, see https://cloud.google.com/dlp/docs/reference/rest/v2beta1/content/deidentify#FfxCommonNativeAlphabet | ||
| // alphabet = FfxCommonNativeAlphabet.ALPHA_NUMERIC; | ||
|
|
||
| // The name of the Cloud KMS key used to encrypt ('wrap') the AES-256 key | ||
| // keyName = "projects/YOUR_GCLOUD_PROJECT/locations/YOUR_LOCATION/keyRings/YOUR_KEYRING_NAME/cryptoKeys/YOUR_KEY_NAME"; | ||
|
|
||
| // The encrypted ('wrapped') AES-256 key to use | ||
| // This key should be encrypted using the Cloud KMS key specified above | ||
| // const wrappedKey = "YOUR_ENCRYPTED_AES_256_KEY" | ||
|
|
||
| ContentItem contentItem = | ||
| ContentItem.newBuilder() | ||
| .setType("text/plain") | ||
| .setValue(string) | ||
| .build(); | ||
|
|
||
| KmsWrappedCryptoKey kmsWrappedCryptoKey = | ||
|
There was a problem hiding this comment. Same comment as earlier, better comments around these objects and ideally some of these can get cleaned up on the surface. This looks very cumbersome to the user. |
||
| KmsWrappedCryptoKey.newBuilder() | ||
| .setWrappedKey(ByteString.copyFrom(BaseEncoding.base64().decode(wrappedKey))) | ||
| .setCryptoKeyName(keyName) | ||
| .build(); | ||
|
|
||
| CryptoKey cryptoKey = | ||
| CryptoKey.newBuilder() | ||
| .setKmsWrapped(kmsWrappedCryptoKey) | ||
| .build(); | ||
|
|
||
| CryptoReplaceFfxFpeConfig cryptoReplaceFfxFpeConfig = | ||
| CryptoReplaceFfxFpeConfig.newBuilder() | ||
| .setCryptoKey(cryptoKey) | ||
| .setCommonAlphabet(alphabet) | ||
| .build(); | ||
|
|
||
| PrimitiveTransformation primitiveTransformation = | ||
| PrimitiveTransformation.newBuilder() | ||
| .setCryptoReplaceFfxFpeConfig(cryptoReplaceFfxFpeConfig) | ||
| .build(); | ||
|
|
||
| InfoTypeTransformation infoTypeTransformationObject = | ||
| InfoTypeTransformation.newBuilder() | ||
| .setPrimitiveTransformation(primitiveTransformation) | ||
| .build(); | ||
|
|
||
| InfoTypeTransformations infoTypeTransformationArray = | ||
| InfoTypeTransformations.newBuilder() | ||
| .addTransformations(infoTypeTransformationObject) | ||
| .build(); | ||
|
|
||
| DeidentifyConfig deidentifyConfig = | ||
| DeidentifyConfig.newBuilder() | ||
| .setInfoTypeTransformations(infoTypeTransformationArray) | ||
| .build(); | ||
|
|
||
| DeidentifyContentRequest request = | ||
| DeidentifyContentRequest.newBuilder() | ||
| .setDeidentifyConfig(deidentifyConfig) | ||
| .addItems(contentItem) | ||
| .build(); | ||
|
|
||
| DeidentifyContentResponse response = dlpServiceClient.deidentifyContent(request); | ||
|
|
||
| for (ContentItem item : response.getItemsList()) { | ||
| System.out.println(item.getValue()); | ||
| } | ||
| } catch (Exception e) { | ||
| System.out.println("Error in deidentifyWithFpe: " + e.getMessage()); | ||
| } | ||
| // [END dlp_deidentify_fpe] | ||
| } | ||
|
|
||
| /** | ||
| * Command line application to de-identify data using the Data Loss Prevention API. | ||
| * Supported data format: strings | ||
| */ | ||
| public static void main(String[] args) throws Exception { | ||
|
|
||
| OptionGroup optionsGroup = new OptionGroup(); | ||
| optionsGroup.setRequired(true); | ||
|
|
||
| Option deidentifyMaskingOption = new Option("m", "mask", true, "deid with character masking"); | ||
| optionsGroup.addOption(deidentifyMaskingOption); | ||
|
|
||
| Option deidentifyFpeOption = new Option("f", "fpe", true, "deid with FFX FPE"); | ||
| optionsGroup.addOption(deidentifyFpeOption); | ||
|
|
||
| Options commandLineOptions = new Options(); | ||
| commandLineOptions.addOptionGroup(optionsGroup); | ||
|
|
||
| Option maskingCharacterOption = Option.builder("maskingCharacter").hasArg(true).required(false).build(); | ||
| commandLineOptions.addOption(maskingCharacterOption); | ||
|
|
||
| Option numberToMaskOption = Option.builder("numberToMask").hasArg(true).required(false).build(); | ||
| commandLineOptions.addOption(numberToMaskOption); | ||
|
|
||
| Option alphabetOption = Option.builder("commonAlphabet").hasArg(true).required(false).build(); | ||
| commandLineOptions.addOption(alphabetOption); | ||
|
|
||
| Option wrappedKeyOption = Option.builder("wrappedKey").hasArg(true).required(false).build(); | ||
| commandLineOptions.addOption(wrappedKeyOption); | ||
|
|
||
| Option keyNameOption = Option.builder("keyName").hasArg(true).required(false).build(); | ||
| commandLineOptions.addOption(keyNameOption); | ||
|
|
||
| CommandLineParser parser = new DefaultParser(); | ||
| HelpFormatter formatter = new HelpFormatter(); | ||
| CommandLine cmd; | ||
|
|
||
| try { | ||
| cmd = parser.parse(commandLineOptions, args); | ||
| } catch (ParseException e) { | ||
| System.out.println(e.getMessage()); | ||
| formatter.printHelp(DeId.class.getName(), commandLineOptions); | ||
| System.exit(1); | ||
| return; | ||
| } | ||
|
|
||
| if (cmd.hasOption("m")) { | ||
| // deid with character masking | ||
| int numberToMask = Integer.parseInt(cmd.getOptionValue(numberToMaskOption.getOpt(), "0")); | ||
| char maskingCharacter = cmd.getOptionValue(maskingCharacterOption.getOpt(), "*").charAt(0); | ||
| String val = cmd.getOptionValue(deidentifyMaskingOption.getOpt()); | ||
| deidentifyWithMask(val, maskingCharacter, numberToMask); | ||
| } else if (cmd.hasOption("f")) { | ||
| // deid with FPE | ||
| String wrappedKey = cmd.getOptionValue(wrappedKeyOption.getOpt()); | ||
| String keyName = cmd.getOptionValue(keyNameOption.getOpt()); | ||
| String val = cmd.getOptionValue(deidentifyFpeOption.getOpt()); | ||
| FfxCommonNativeAlphabet alphabet = | ||
| FfxCommonNativeAlphabet.valueOf( | ||
| cmd.getOptionValue( | ||
| alphabetOption.getOpt(), FfxCommonNativeAlphabet.ALPHA_NUMERIC.name())); | ||
| deidentifyWithFpe(val, alphabet, keyName, wrappedKey); | ||
| } | ||
| } | ||
| } | ||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please avoid .* imports
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.