MBS-15 CLEAN-UP

.editorconfig

@@ -0,0 +1,11 @@
+[*]
+charset=utf-8
+end_of_line=lf
+insert_final_newline=false
+indent_style=space
+indent_size=4
+
+[*.json]
+indent_style=space
+indent_size=2
+

.gitignore

@@ -27,3 +27,5 @@ HELP.md
 
 ### VS Code ###
 .vscode/
+
+media_directory/

README.md

@@ -1,3 +1,74 @@
 # Turkana Message Backup Service
 This application provide a service to allow backing up of client messages exchanged using
-Muzima mobile applications.
+Muzima mobile applications.
+
+## REST API Specification
+Provided using [Swagger 2 | https://swagger.io]. To access these API docs using the browser simply visit
+ `/swagger-ui.html` and to get a json response use the endpoint `/v2/api-docs`
+
+## MESSAGE/PAYLOAD VERIFICATION
+Before saving submitted messages to be backed up, the server provides the facility to verify them. The process works as follows.
+
+### Single SMS submission
+The sender signs the message body using their private key. The algorithm used for this is `SHA256withRSA`. The URL base64 encoded signature is then
+sent along with the payload as the `signature` query parameter. Below is the java snippet to accomplish that.
+```java
+import java.security.Signature;
+import java.security.SignatureException;
+import java.util.Base64;
+
+class SignDemo {
+    public static final String ALGORITHM = "SHA256withRSA";
+
+    public static String signMessage(String messageBody, PrivateKey privateKey)  throws NoSuchAlgorithmException, InvalidKeyException,
+        SignatureException {
+        Signature rsa = Signature.getInstance(ALGORITHM);
+        rsa.initSign(privateKey);
+        rsa.update(messageBody.getBytes());
+
+        byte[] signature = rsa.sign();
+        return Base64.getUrlEncoder().encodeToString(signature);
+    }
+}
+```
+
+### Multiple SMSes SENT TOGETHER.
+The procedure is similar to single SMS except in this one, all message bodies are concatenated, hashed using the `SHA-256` algorithm, signed and then 
+signed. See example snippet below.
+
+*Note:* The order of messages matters.
+```java
+import java.security.Signature;
+import java.security.SignatureException;
+import java.util.Base64;
+import java.security.MessageDigest;
+
+class SignDemo {
+    public static final String ALGORITHM = "SHA256withRSA";
+    public static final String MD_ALG = "SHA-256";
+
+    public static String signMessage(String[] messageBodies, PrivateKey privateKey)  throws NoSuchAlgorithmException, InvalidKeyException,
+        SignatureException {
+        Signature rsa = Signature.getInstance(ALGORITHM);
+        rsa.initSign(privateKey);
+
+        MessageDigest md = MessageDigest.getInstance(MD_ALG);
+
+        StringBuilder sb = new StringBuilder();
+        for(String messageBody: messageBodies) {
+            sb.append(messageBody);
+        }
+        // Digest.
+        byte[] digested = md.digest(sb.toString().getBytes());
+        rsa.update(digested);
+        byte[] signature = rsa.sign();
+        return Base64.getUrlEncoder().encodeToString(signature);
+    }
+}
+```
+
+### Single & Multiple MMS
+These work similar to SMS implementation.
+
+### Media (Image, Audio, Video, Documents) Uploads.
+This uses three metadata fields namely phonenumber, size, and media type in that order. The three are concatenated and signed.

pom.xml

@@ -1,121 +1,162 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-	<modelVersion>4.0.0</modelVersion>
-	<parent>
-		<groupId>org.springframework.boot</groupId>
-		<artifactId>spring-boot-starter-parent</artifactId>
-		<version>2.1.4.RELEASE</version>
-		<relativePath/> <!-- lookup parent from repository -->
-	</parent>
-	<groupId>org.muzima</groupId>
-	<artifactId>turkana</artifactId>
-	<version>0.0.1-SNAPSHOT</version>
-	<packaging>war</packaging>
-	<name>Turkana</name>
-	<description>Message Backup Server</description>
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-starter-parent</artifactId>
+        <version>2.1.4.RELEASE</version>
+        <relativePath/>
+        <!-- lookup parent from repository -->
+    </parent>
+    <groupId>org.muzima</groupId>
+    <artifactId>turkana</artifactId>
+    <version>1.0.0-SNAPSHOT</version>
+    <packaging>war</packaging>
+    <name>Turkana</name>
+    <description>Message Backup Server</description>
 
-	<developers>
+    <developers>
 
-		<developer>
-			<name>Samuel Owino</name>
-			<email>[email protected]</email>
-			<organization>mUzima</organization>
-			<organizationUrl>www.muzima.org</organizationUrl>
-		</developer>
+        <developer>
+            <name>Samuel Owino</name>
+            <email>[email protected]</email>
+            <organization>mUzima</organization>
+            <organizationUrl>www.muzima.org</organizationUrl>
+        </developer>
 
-		<developer>
-			<name>Mhawila Mhawila (Willa)</name>
-			<email>[email protected]</email>
-			<organization>VUMC</organization>
-			<organizationUrl> www.vumc.org</organizationUrl>
-		</developer>
-	</developers>
+        <developer>
+            <name>Mhawila Mhawila (Willa)</name>
+            <email>[email protected]</email>
+            <organization>VUMC</organization>
+            <organizationUrl>www.vumc.org</organizationUrl>
+        </developer>
 
+    </developers>
 
+    <properties>
+        <java.version>1.8</java.version>
+    </properties>
 
-	<properties>
-		<java.version>1.8</java.version>
-	</properties>
+    <dependencies>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-data-jpa</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
 
-	<dependencies>
-		<dependency>
-			<groupId>org.springframework.boot</groupId>
-			<artifactId>spring-boot-starter-data-jpa</artifactId>
-		</dependency>
-		<dependency>
-			<groupId>org.springframework.boot</groupId>
-			<artifactId>spring-boot-starter-web</artifactId>
-		</dependency>
-		<dependency>
-			<groupId>org.springframework.boot</groupId>
-			<artifactId>spring-boot-starter-security</artifactId>
-		</dependency>
+        <dependency>
+            <groupId>mysql</groupId>
+            <artifactId>mysql-connector-java</artifactId>
+            <scope>runtime</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.security</groupId>
+            <artifactId>spring-security-test</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.googlecode.json-simple</groupId>
+            <artifactId>json-simple</artifactId>
+            <version>1.1.1</version>
+        </dependency>
+        <dependency>
+            <groupId>com.querydsl</groupId>
+            <artifactId>querydsl-jpa</artifactId>
+            <version>${querydsl.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.h2database</groupId>
+            <artifactId>h2</artifactId>
+            <version>${h2.version}</version>
+            <scope>test</scope>
+        </dependency>
 
-		<dependency>
-			<groupId>mysql</groupId>
-			<artifactId>mysql-connector-java</artifactId>
-			<scope>runtime</scope>
-		</dependency>
-		<dependency>
-			<groupId>org.springframework.boot</groupId>
-			<artifactId>spring-boot-starter-test</artifactId>
-			<scope>test</scope>
-		</dependency>
-		<dependency>
-			<groupId>org.springframework.security</groupId>
-			<artifactId>spring-security-test</artifactId>
-			<scope>test</scope>
-		</dependency>
-		<dependency>
-			<groupId>com.googlecode.json-simple</groupId>
-			<artifactId>json-simple</artifactId>
-			<version>1.1.1</version>
-		</dependency>
-		<dependency>
-			<groupId>com.querydsl</groupId>
-			<artifactId>querydsl-jpa</artifactId>
-			<version>${querydsl.version}</version>
-		</dependency>
-		<dependency>
-			<groupId>com.h2database</groupId>
-			<artifactId>h2</artifactId>
-			<version>${h2.version}</version>
-			<scope>test</scope>
-		</dependency>
-	</dependencies>
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger-ui</artifactId>
+            <version>2.9.2</version>
+        </dependency>
 
-	<build>
-		<plugins>
-			<plugin>
-				<groupId>org.springframework.boot</groupId>
-				<artifactId>spring-boot-maven-plugin</artifactId>
-			</plugin>
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger2</artifactId>
+            <version>2.9.2</version>
+        </dependency>
 
-			<plugin>
-				<groupId>com.mysema.maven</groupId>
-				<artifactId>apt-maven-plugin</artifactId>
-				<version>1.1.3</version>
-				<executions>
-					<execution>
-						<goals>
-							<goal>process</goal>
-						</goals>
-						<configuration>
-							<outputDirectory>target/generated-sources/java</outputDirectory>
-							<processor>com.querydsl.apt.jpa.JPAAnnotationProcessor</processor>
-						</configuration>
-					</execution>
-				</executions>
-				<dependencies>
-					<dependency>
-						<groupId>com.querydsl</groupId>
-						<artifactId>querydsl-apt</artifactId>
-						<version>${querydsl.version}</version>
-					</dependency>
-				</dependencies>
-			</plugin>
-		</plugins>
-	</build>
+        <dependency>
+            <groupId>org.whispersystems</groupId>
+            <artifactId>signal-service-java</artifactId>
+            <version>2.7.2</version>
+        </dependency>
+
+        <dependency>
+            <groupId>com.google.gcm</groupId>
+            <artifactId>gcm-server</artifactId>
+            <version>1.0.0</version>
+        </dependency>
+        <dependency>
+            <groupId>com.google.firebase</groupId>
+            <artifactId>firebase-admin</artifactId>
+            <version>6.8.1</version>
+        </dependency>
+        <dependency>
+            <groupId>com.google.gcm</groupId>
+            <artifactId>gcm-server</artifactId>
+            <version>1.0.0</version>
+        </dependency>
+        <dependency>
+            <groupId>net.coobird</groupId>
+            <artifactId>thumbnailator</artifactId>
+            <version>0.4.8</version>
+        </dependency>
+
+        <dependency>
+            <groupId>org.greenrobot</groupId>
+            <artifactId>eventbus</artifactId>
+            <version>3.0.0</version>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-maven-plugin</artifactId>
+            </plugin>
+
+            <plugin>
+                <groupId>com.mysema.maven</groupId>
+                <artifactId>apt-maven-plugin</artifactId>
+                <version>1.1.3</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>process</goal>
+                        </goals>
+                        <configuration>
+                            <outputDirectory>target/generated-sources/java</outputDirectory>
+                            <processor>com.querydsl.apt.jpa.JPAAnnotationProcessor</processor>
+                        </configuration>
+                    </execution>
+                </executions>
+                <dependencies>
+                    <dependency>
+                        <groupId>com.querydsl</groupId>
+                        <artifactId>querydsl-apt</artifactId>
+                        <version>${querydsl.version}</version>
+                    </dependency>
+                </dependencies>
+            </plugin>
+        </plugins>
+    </build>
 
 </project>

src/main/java/org/muzima/TurkanaApplication.java

@@ -9,5 +9,4 @@ public class TurkanaApplication {
     public static void main(String[] args) {
         SpringApplication.run(TurkanaApplication.class, args);
     }
-
 }