irma_sms_issuer

The IRMA SMS issuer takes care of issuing a mobile phone number to Yivi app users. It consists of a Java backend API, which connects to an irma server (issuer) and an SMS gateway service, and a frontend web app.

Running (development)

The easiest way to run the irma_sms_issuer for development purposes is by having a phone with the Yivi app installed and Docker.

Setup listening for SMS messages:

To be able to get the verification code execute socat in a separate terminal to intercept relevant local traffic:

$ socat -v TCP-LISTEN:8766,crlf,reuseaddr,fork SYSTEM:"echo HTTP/1.1 200"

If you have an Android device you can also install StartHere SMS Gateway App. This will give you a more visual experience. Make sure your development machine and phone are on the same network. And then, when the app is started, it runs a local server imitating an SMS sending gateway. SMS messages, in the form of POST requests coming from irma_sms_issuer, are sent to this messaging service and will be displayed inside the app.

Configuration

Various configuration files, keys and settings need to be in place to be able to build and run the apps.

1. To generate the required keys, run:

$ utils/keygen.sh ./src/main/resources/sk ./src/main/resources/pk

2. Create the Java app configuration: Copy the file src/main/resources/config.sample.json to src/main/resources/config.json and set the sms_sender_address to match the IP address of your localhost or the Address displayed in the StartHere SMS Gateway app. For example:

{
  "sms_sender_address": "http://192.168.1.100:8766",
}

Redis

For Redis the following environment variables need to be set:

Name	Description
REDIS_HOST	Host to reach the redis at
REDIS_PORT	Port to reach the redis at
REDIS_MASTER_NAME	The master name for the Redis Sentinel
REDIS_USERNAME	Username for the Redis user
REDIS_PASSWORD	The password for the Redis user
REDIS_KEY_PREFIX	The prefix to use for all redis keys
STORAGE_TYPE	The type of storage used: if you want to enable Redis, set it to "redis"

Run

Use docker-compose up combined with your localhost IP address as environment variable to spin up the containers:

$ IP=192.168.1.105 docker-compose up

Note: do not use 127.0.0.1 or 0.0.0.0 as IP addresses as this will result in the app not being able to find the issuer.

The configuration should be mounted in the /config directory of the container. The docker-compose.yml file already contains this configuration.

By default, docker-compose caches docker images, so on a second run the previous built images will be used. A fresh build can be enforced using the --build flag.

$ IP=192.168.1.105 docker-compose up --build

Navigate to http://localhost:8080 in your browser and follow the instructions to test the complete flow.

Manually

The Java api and JavaScript frontend can be built and run manually. To do so:

Build

1. Generate JWT keys for the issuer

$ utils/keygen.sh ./src/main/resources/sk ./src/main/resources/pk

2. Copy the file src/main/resources/config.sample.json to src/main/resources/config.json and modify it.

3. Build the webapp:

$ cd webapp
$ yarn install
$ yarn build en

The last command builds the English version of the webapp. To build another language, for example Dutch, run yarn build nl instead.

4. Copy the file webapp/config.example.js to webapp/build/assets/config.js and modify it

5. Run the following command in the root directory of this project:

$ gradle appRun

To open the webapp navigate to http://localhost:8080/irma_sms_issuer. The API is accessible via http://localhost:8080/irma_sms_issuer/api.

Test

You can run the tests, defined in src/test/java/foundation/privacybydesign/sms/ratelimit, using the following command:

$ gradle test