GoogleAppEngine Flexible - SpringBoot Sqreen Sample

This sample shows how to deploy a Spring Boot application protected by Sqreen to Google App Engine flexible with Docker image. For simplicity and transparency, the example is based on the sample from GoogleCloudPlatform. Below you will find a Sqreen Integration Guide with required steps to use a Sqrreen Java Agent in the project deployed to the Google App Engine flexible.

Prerequisites

• JDK11
• Maven
• Google Cloud console

Run application

• Set the correct Cloud SDK project via gcloud config set project YOUR_PROJECT to the ID of your application.
• Put your SQREEN_TOKEN and SQREEN_APP_NAME to src/main/appengine/app.yaml
• Build and deploy application mvn clean package appengine:deploy
• View web app gcloud app browse (or navigate https://<your-project-id>.appspot.com)
• In response HTTP headers you should see string x-protected-by: Sqreen

Sqreen Integration Guide

1. Download java agent sqreen.jar into dedicated project folder. In the sample java agent located at sqreen/sqreen.jar
2. To use Sqreen, you need add Dockerfile where will app run (Docker image should contains both jar-files and app.jar, and sqreen.jar). Put Dockerfile to /src/main/docker/Dockerfile:

FROM openjdk:11-jre-slim

COPY helloworld-*.jar /app.jar
COPY sqreen.jar /sqreen.jar

CMD ["java", "-javaagent:sqreen.jar", "-Dsqreen.log_level=INFO", "-jar", "/app.jar"]

3. Runtime should be custom at app.yaml to make it works with prepared Dockerfile.
4. Sqreen requires SQREEN_TOKEN and SQREEN_APP_NAME related to your Sqreen account. Get token and app from your dashboard and add them as environement variables to app.yaml:

env_variables:
    SQREEN_APP_NAME: XXXXXXXXX
    SQREEN_TOKEN: env_org_XXXXXXXXX

5. To make Google App Engine use Sqreen - add external files directory (where the sqreen.jar stored), to maven configuration pom.xml. If you are using Gradle to build your project, you must use similar configuration to include external files (please check official documentation).

<plugin>
    <groupId>com.google.cloud.tools</groupId>
    <artifactId>appengine-maven-plugin</artifactId>
    ...
    <configuration>
        ....
        <extraFilesDirectories>
            <extraFilesDirectory>sqreen</extraFilesDirectory>
        </extraFilesDirectories>
    </configuration>
</plugin>

6. Build, deploy and test the app with Sqreen protection.