Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/VirgilSecurity/demo-firebase-ios

[DEPRECATED] See https://github.com/VirgilSecurity/demo-e3kit-ios and https://github.com/VirgilSecurity/virgil-e3kit-firebase-func for up-to-date code. -- A simple iOS application that demonstrates how the end-to-end encryption works. The application uses firebase as a backend service for authentication and chat messaging.
https://github.com/VirgilSecurity/demo-firebase-ios

cryptography e2ee encryption end-to-end-encryption firebase firebase-cloud-messaging ios ios-app secured-by-virgil

Last synced: 3 months ago
JSON representation

[DEPRECATED] See https://github.com/VirgilSecurity/demo-e3kit-ios and https://github.com/VirgilSecurity/virgil-e3kit-firebase-func for up-to-date code. -- A simple iOS application that demonstrates how the end-to-end encryption works. The application uses firebase as a backend service for authentication and chat messaging.

Awesome Lists containing this project

README 

        
# End-to-end encrypted, HIPAA-compliant iOS chat app for Firebase.

You can reuse this sample in any Firebase project where you want to end-to-end protect user data, documents, images using Virgil's end-to-end encryption. [If you're working on a project that needs to be HIPAA-compliant, see our whitepaper for more technical and legal details ](https://virgilsecurity.com/wp-content/uploads/2018/07/Firebase-HIPAA-Chat-Whitepaper-Virgil-Security.pdf).



[Also, we've created a helpful video on YouTube to walk you through the steps below and explains what you'll be doing for the next 10 minutes or so. Popcorn not included](https://www.youtube.com/watch?v=6zpzbcm_3I8).



**This Demo is based on [Virgil Objective-C/Swift SDK](https://github.com/VirgilSecurity/virgil-sdk-x).** 



Looking for other client platforms? 

- [Android](https://github.com/VirgilSecurity/demo-firebase-android) is based on [Virgil Java (Android) SDK](https://github.com/VirgilSecurity/virgil-sdk-java-android)

- [JavaScript (browser)](https://github.com/VirgilSecurity/demo-firebase-js) is based on [Virgil E3Kit Typescript/Javascript SDK](https://github.com/VirgilSecurity/virgil-e3kit-js). Our new client-side SDK.



## Clone project

```bash

git clone https://github.com/VirgilSecurity/demo-firebase-ios

cd demo-firebase-ios

```



## Connect your Virgil and Firebase accounts

In order for the app to work, you need to deploy a Firebase function that gives out Virgil JWT tokens for your authenticated users. You'll also need to create a Firestore database with a specific rule set.



* **[Follow instructions here](https://github.com/VirgilSecurity/demo-firebase-func)**



> You only need to do this once - if you already did it earlier or for your Android or JavaScript clients, you don't need to do it again.



## Add your Firebase function URL and Firebase project config to your app



* **Copy your new Firebase function's URL**: go to the Firebase console -> your project -> Functions tab and copy your new function's url

* **Go to Xcode -> Firebase Chat iOS/Helpers/Virgil/VirgilHelper.swift and change variable jwtEndpoint to**:

  ```

  https://YOUR_FUNCTION_URL.cloudfunctions.net/api/generate_jwt

  ```

* Go back to your project's page in Firebase console, click the **gear icon** -> **Project settings**

* Click **Add app** and choose **"iOS: Add Firebase to your iOS app"**

* Change the bundle ID to your own (or make one up), click **Register app**

* **Download GoogleService-Info.plist** into the **Firebase Chat iOS** directory of this sample.



## Install dependencies

The sample app uses several modules, including Virgil SDK and Firebase Firestore.



> **Cocoapods** manages dependencies for your Xcode projects. If you don't have it, install it with [Homebrew](http://brew.sh/):

   ```bash

   brew update

   brew install cocoapods

   ```



* **Update dependencies**

The sample already has a Pod file with all required dependencies: run the following commands to update these dependencies:

  ```bash 

  pod install

  open Firebase\ Chat\ iOS.xcworkspace/

  ```



## Build and Run

At this point you are ready to build and run the application on your iPhone or Simulator.



> You will want to try your new chat app with 2 users. Not sure how to run 2 simulators? Check out [How to run multiple simulators on Xcode 9?](https://stackoverflow.com/questions/44384677/how-to-run-multiple-simulators-on-xcode-9)



> Remember, the app deletes messages right after delivery (it's a HIPAA requirement to meet the conduit exception). If you want to see encrypted messages in your Firestore database, run only 1 app instance, send a message to your chat partner and check Firestore DB's contents before opening the other user's app to receive the message. If you don't want to implement this behavior in your own app, you can remove it from this sample.