Inspect sensitive text by using Node.js

Learn how to scan a sample string for sensitive information by using the Cloud Data Loss Prevention API of Sensitive Data Protection, the Google Cloud CLI, and Node.js.

To follow step-by-step guidance for this task directly in the Google Cloud console, click Guide me:

Guide me

Before you begin

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get 300ドル in free credits to run, test, and deploy workloads.
Install the Google Cloud CLI.
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
To initialize the gcloud CLI, run the following command:
gcloudinit
Create or select a Google Cloud project.
Roles required to select or create a project
• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.
• Create a Google Cloud project:

  gcloud projects create PROJECT_ID

  Replace PROJECT_ID with a name for the Google Cloud project you are creating.

• Select the Google Cloud project that you created:

  gcloud config set project PROJECT_ID

  Replace PROJECT_ID with your Google Cloud project name.
Verify that billing is enabled for your Google Cloud project.
Enable the DLP API:
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.
gcloudservicesenabledlp.googleapis.com
Create local authentication credentials for your user account:
gcloudauthapplication-defaultlogin
If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.
Grant roles to your user account. Run the following command once for each of the following IAM roles: roles/dlp.user
gcloudprojectsadd-iam-policy-bindingPROJECT_ID--member="user:USER_IDENTIFIER"--role=ROLE
Replace the following:
• PROJECT_ID: Your project ID.
• USER_IDENTIFIER: The identifier for your user account. For example, myemail@example.com.
• ROLE: The IAM role that you grant to your user account.

Install the Google Cloud CLI.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

To initialize the gcloud CLI, run the following command:

gcloudinit

Create or select a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

• Create a Google Cloud project:

  gcloud projects create PROJECT_ID

  Replace PROJECT_ID with a name for the Google Cloud project you are creating.

• Select the Google Cloud project that you created:

  gcloud config set project PROJECT_ID

  Replace PROJECT_ID with your Google Cloud project name.

Verify that billing is enabled for your Google Cloud project.

Enable the DLP API:

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

gcloudservicesenabledlp.googleapis.com

Create local authentication credentials for your user account:

gcloudauthapplication-defaultlogin

If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

Grant roles to your user account. Run the following command once for each of the following IAM roles: roles/dlp.user

gcloudprojectsadd-iam-policy-bindingPROJECT_ID--member="user:USER_IDENTIFIER"--role=ROLE

Replace the following:

• PROJECT_ID: Your project ID.
• USER_IDENTIFIER: The identifier for your user account. For example, myemail@example.com.
• ROLE: The IAM role that you grant to your user account.
1. Install Node.js and NPM.

Set up a Sensitive Data Protection CLI app

To set up a Sensitive Data Protection CLI app using Node.js, do the following:

1. Clone the Node.js DLP client library:

   gitclonehttps://github.com/GoogleCloudPlatform/nodejs-docs-samples
   

2. Navigate to the dlp directory.

   cdnodejs-docs-samples/dlp
   

3. Install the app dependencies:

   npminstall
   

Inspect a string for sensitive information

To scan sample text by using the DLP API and the inspectString Node.js script, run the following command:

nodeinspectString.jsPROJECT_ID"My email address is joe@example.com."

The output is similar to the following:

 Findings:
 Info type: EMAIL_ADDRESS
 Likelihood: LIKELY

Clean up

To avoid incurring charges to your Google Cloud account for the resources used on this page, delete the Google Cloud project with the resources.

Delete the project

If you created a new project for this quickstart, the easiest way to prevent additional charges is to delete the project.

Delete a Google Cloud project:

gcloud projects delete PROJECT_ID

Revoke your credentials

1. Optional: Revoke the authentication credentials that you created, and delete the local credential file.

   gcloudauthapplication-defaultrevoke

2. Optional: Revoke credentials from the gcloud CLI.

   gcloudauthrevoke

What's next

• To get started with inspecting text and images for sensitive data, see How-to guides.

• To better understand inspection, redaction, infoTypes, and likelihood, see Concepts.

• Learn more about the DLP API.

• Learn more about the Cloud DLP Node.js Client.