Added a docker stack to easily run the servers for the Approov Integration examples.

Exadra37 · Exadra37 · commit 54dba509f6c4 · 2022-03-22T19:16:33.000Z
Signed-off-by: Exadra37 &lt;exadra37@gmail.com&gt;
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,54 @@
+ARG TAG=8.1.4-cli
+
+FROM php:${TAG}
+
+ARG CONTAINER_USER="developer"
+ARG LANGUAGE_CODE="en"
+ARG COUNTRY_CODE="GB"
+ARG ENCODING="UTF-8"
+
+ARG LOCALE_STRING="${LANGUAGE_CODE}_${COUNTRY_CODE}"
+ARG LOCALIZATION="${LOCALE_STRING}.${ENCODING}"
+
+ARG OH_MY_ZSH_THEME="bira"
+
+RUN apt update && apt -y upgrade && \
+    apt -y install \
+        locales \
+        git \
+        curl \
+        inotify-tools \
+        zip \
+        unzip \
+        zsh && \
+
+        echo "${LOCALIZATION} ${ENCODING}" > /etc/locale.gen && \
+        locale-gen "${LOCALIZATION}" && \
+
+        useradd -m -u 1000 -s /usr/bin/zsh "${CONTAINER_USER}" && \
+
+        bash -c "$(curl -fsSL https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh)" && \
+
+        cp -v /root/.zshrc /home/"${CONTAINER_USER}"/.zshrc && \
+        cp -rv /root/.oh-my-zsh /home/"${CONTAINER_USER}"/.oh-my-zsh && \
+        sed -i "s/\/root/\/home\/${CONTAINER_USER}/g" /home/"${CONTAINER_USER}"/.zshrc && \
+        sed -i s/ZSH_THEME=\"robbyrussell\"/ZSH_THEME=\"${OH_MY_ZSH_THEME}\"/g /home/${CONTAINER_USER}/.zshrc && \
+        mkdir /home/"${CONTAINER_USER}"/workspace && \
+        chown -R "${CONTAINER_USER}":"${CONTAINER_USER}" /home/"${CONTAINER_USER}"
+
+USER ${CONTAINER_USER}
+
+ENV USER ${CONTAINER_USER}
+ENV LANG "${LOCALIZATION}"
+ENV LANGUAGE "${LOCALE_STRING}:${LANGUAGE_CODE}"
+ENV PATH=/home/${CONTAINER_USER}/.local/bin:${PATH}
+ENV LC_ALL "${LOCALIZATION}"
+
+WORKDIR /home/${CONTAINER_USER}/workspace
+
+RUN mkdir -p /home/${CONTAINER_USER}/.local/bin && \
+    curl https://raw.githubusercontent.com/composer/getcomposer.org/76a7060ccb93902cd7576b67264ad91c8a2700e2/web/installer | php -- --quiet && \
+    mv composer.phar /home/${CONTAINER_USER}/.local/bin/composer && \
+    composer about
+
+CMD ["zsh"]
diff --git a/EXAMPLES.md b/EXAMPLES.md
@@ -0,0 +1,97 @@
+# Approov Integrations Examples
+
+[Approov](https://approov.io) is an API security solution used to verify that requests received by your backend services originate from trusted versions of your mobile apps, and here you can find the Hello servers examples that are the base for the Approov [quickstarts](/docs) for the Laravel PHP Framework.
+
+For more information about how Approov works and why you should use it you can read the [README](/README.md) at the root of this repo.
+
+If you are looking for the Approov quickstarts to integrate Approov in your Laravel API server then you can find them [here](/docs).
+
+
+## Hello Server Examples
+
+To learn more about each Hello server example you need to read the README for each one at:
+
+* [Unprotected Server](./src/unprotected-server/hello)
+* [Approov Protected Server - Token Check](./src/approov-protected-server/token-check/hello)
+* [Approov Protected Server - Token Binding Check](./src/approov-protected-server/token-binding-check/hello)
+
+
+## Docker Stack
+
+The docker stack provided via the `docker-compose.yml` file in this folder is used for development proposes and if you are familiar with docker then feel free to also use it to follow along the examples on the README of each server.
+
+If you decide to use the docker stack then you need to bear in mind that the Postman collections, used to test the servers examples, will connect to port `8002` therefore you cannot start all docker compose services at once, for example with `docker-compose up`, instead you need to run one at a time as exemplified below.
+
+### Setup Env File
+
+Do not forget to properly setup the `.env` file in the root of each Approov protected server example before you run the server with the docker stack.
+
+```bash
+cp src/unprotected-server/hello/.env.example src/unprotected-server/hello/.env
+cp src/approov-protected-server/token-check/hello/.env.example src/approov-protected-server/token-check/hello/.env
+cp src/approov-protected-server/token-binding-check/hello/.env.example src/approov-protected-server/token-binding-check/hello/.env
+```
+
+Edit each file and add the [dummy secret](/README.md#the-dummy-secret) to it in order to be able to test the Approov integration with the provided [Postman collection](https://github.com/approov/postman-collections/blob/master/quickstarts/hello-world/hello-world.postman_curl_requests_examples.md).
+
+
+### Build the Docker Stack
+
+The three services in the `docker-compose.yml` use the same Dockerfile, therefore to build the Docker image we just need to used one of them:
+
+```bash
+sudo docker-compose build approov-token-binding-check
+```
+
+Now, you are ready to start using the Docker stack for Laravel PHP Framework.
+
+
+### Command Examples
+
+To run each of the Hello servers with docker compose you just need to follow the respective example below.
+
+#### For the unprotected server
+
+Run the container attached to your machine bash shell:
+
+```bash
+sudo docker-compose up unprotected-server
+```
+
+or get a bash shell inside the container:
+
+```bash
+sudo docker-compose run --rm --service-ports unprotected-server zsh
+```
+
+#### For the Approov Token Check
+
+Run the container attached to the shell:
+
+```bash
+sudo docker-compose up approov-token-check
+```
+
+or get a bash shell inside the container:
+
+```bash
+sudo docker-compose run --rm --service-ports approov-token-check zsh
+```
+
+#### For the Approov Token Binding Check
+
+Run the container attached to the shell:
+
+```bash
+sudo docker-compose up approov-token-binding-check
+```
+
+or get a bash shell inside the container:
+
+```bash
+sudo docker-compose run --rm --service-ports approov-token-binding-check zsh
+```
+
+## Support
+
+If you find any issue while following this quickstart then just open an issue on this repo with the steps to reproduce it and we will help you to solve them.
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,37 @@
+version: "2.3"
+
+services:
+
+  unprotected-server:
+    image: approov/php:8.1.4
+    build: ./
+    networks:
+      - default
+    command: sh -c "composer install && php artisan serve --port 8002 --host 0.0.0.0"
+    ports:
+      - ${HOST_IP:-127.0.0.1}:${HTTP_PORT:-8002}:${HTTP_PORT:-8002}
+    volumes:
+      - ./src/unprotected-server/hello:/home/developer/workspace
+
+  approov-token-check:
+    image: approov/php:8.1.4
+    build: ./
+    networks:
+      - default
+    command: sh -c "composer install && php artisan serve --port 8002 --host 0.0.0.0"
+    ports:
+      - ${HOST_IP:-127.0.0.1}:${HTTP_PORT:-8002}:${HTTP_PORT:-8002}
+    volumes:
+      - ./src/approov-protected-server/token-check/hello:/home/developer/workspace
+
+  approov-token-binding-check:
+    image: approov/php:8.1.4
+    build: ./
+    networks:
+      - default
+    command: sh -c "composer install && php artisan serve --port 8002 --host 0.0.0.0"
+    ports:
+      - ${HOST_IP:-127.0.0.1}:${HTTP_PORT:-8002}:${HTTP_PORT:-8002}
+    volumes:
+      - ./src/approov-protected-server/token-binding-check/hello:/home/developer/workspace
+
