Run the sample Web Risk app

Learn how to install the sample Web Risk Go app from GitHub and how to run the sample app to detect malicious URLs in a Go environment.


For step-by-step guidance on this task directly in console, click Guide me:

Guide me


The following sections take you through the same steps as clicking Guide me.

Before you begin

  1. 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.
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Cloud project. Learn how to check if billing is enabled on a project.

  4. Enable the Web Risk API.

    Enable the API

  5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  6. Make sure that billing is enabled for your Cloud project. Learn how to check if billing is enabled on a project.

  7. Enable the Web Risk API.

    Enable the API

  8. Create a new API key for authentication:
    1. In the console navigation menu, click APIs & Services > Credentials.
    2. On the Credentials page, click Create credentials and then select API key.
    3. In the API key created dialog, to copy the key, click Copy key. Close the dialog and secure the key that you copied for later use.
  9. Set up your environment:
    1. In the console, click Activate Cloud Shell to open a terminal window.


      The Cloud Shell terminal can take several seconds to fully load.

    2. Export the API key that you copied.
    3. export APIKEY=API_KEY
      

Install and run the sample Web Risk app

The sample Web Risk app has the following binaries to detect whether the URLs are malicious or safe:

This quickstart document shows how to detect whether the URLs are malicious or safe by using the wrserver server and wrlookup command-line binaries.

Check URLs using the wrserver server binary

  1. In the Cloud Shell terminal, install wrserver:
    go install github.com/google/webrisk/cmd/wrserver@latest
    
  2. Run wrserver with your API key:
    wrserver -apikey=$APIKEY
    

    When you see the Starting server at localhost:8080 message, wrserver is started at localhost:8080.

  3. To preview the application on the localhost, click Web Preview and then select Preview on port 8080.

    Cloud Shell opens the preview URL (port 8080) on its proxy service in a new browser window. The preview URL browser window shows a 404 page not found message.

  4. In the preview URL window, check the following URLs. To check a URL, replace the query string after the preview URL of the local server with the URL you want to check in the following format: PREVIEW_URL/r?url=URL_TO_BE_CHECKED.

    If the URL is unsafe, an interstitial warning page is shown as recommended by Web Risk. If the URL is safe, the client is automatically redirected to the target.

    A fake malware URL:

    http://testsafebrowsing.appspot.com/apiv4/ANY_PLATFORM/MALWARE/URL/
    

    A safe URL:

     http://www.google.com/
    
  5. To stop the server, press Control+C.

You have successfully verified the URLs by using the wrserver server binary.

Check URLs using the wrlookup command-line binary

  1. In the Cloud Shell terminal, install the wrlookup command-line binary:
    go install github.com/google/webrisk/cmd/wrlookup@latest
  2. Check the URLs with your API key.

    A fake malware URL:

     echo "http://testsafebrowsing.appspot.com/apiv4/ANY_PLATFORM/MALWARE/URL/" | wrlookup -apikey=$APIKEY

    The following output is an abbreviated output for a malware URL:

       ......
       Unsafe URL: [MALWARE]
    

    A safe URL:

     echo "http://www.google.com/" | wrlookup -apikey=$APIKEY

    The following output is an abbreviated output for a safe URL:

       ......
       Safe URL: http://google.com
    

You have successfully verified the URLs by using the wrlookup command-line binary.

Clean up

To avoid incurring charges to your Google Cloud account for the resources used on this page, follow these steps.

Keep the following things in mind when deleting a project:

  • Deleting a project deletes all the resources in the project.
  • You cannot reuse the custom project ID of a deleted project.

If you plan to explore multiple tutorials and quickstarts, reusing projects can help you avoid exceeding project quota limits.

To delete your project, do the following:

  1. In the console navigation menu, click IAM & Admin > Settings.

    Go to Settings

  2. Confirm that the project name is the name of the project you want to delete.

    If it isn't, choose the project you want to delete from the Project selector.

  3. Click Shut down.
  4. In the dialog, type the project ID, then click Shut down to delete the project.

What's next