karthikvt26 / file-sharing-app

A simple file sharing application using Hasura

Share-It: A file sharing application

This project is the API backend for a file-sharing application. It has the following features:

1. Login/registration for users (via Hasura Auth APIs)
2. Upload/Download files (via Hasura Filestore APIs)
3. File sharing (modelled as tables in the database, APIs via Hasura Data APIs)

Quickstart

Here are the 2 steps to deploy this application on your own Hasura free cluster. Before you begin, ensure you have the latest version of hasura CLI tool installed.

Step 1: Clone this project and create a free hasura cluster

$ hasura quickstart karthik/file-sharing-app
$ cd file-sharing-app

The above command does the following:

1. Creates a new folder in the current working directory called file-sharing-app
2. Creates a new trial hasura cluster for you and sets that cluster as the default cluster for this project
3. Initializes file-sharing-app as a git repository and adds the necessary git remotes.

Step 2: Deploy to your new cluster!

$ git add .
$ git commit -m "Initial Commit"
$ git push hasura master

---

Project structure

This Hasura project contains the following:

1. migrations/: This contains the schema of the data model for file sharing

• 3 tables: user, user_file and file_share

2. microservices/file-check: A nodejs microservice which implements a permissions webhook API
3. conf/filestore.yaml: Configure hasura filestore APIs to use a custom permission webhook

More details about how this application works are available in the last section of this README.

---

Test the APIs

To test and browse the APIs that are deployed, open up the api-console:

$ hasura api-console

This will open up the API console on http://localhost:9695 and will allow you to start testing your APIs.

Step 1: Create 2 users

On the API console, head to the API explorer. On the sidebar, choose the Auth > Username/password login > Signup API and create 2 users using the Hasura Auth APIs.

Let's say the first username is alice and the second is bob.

Note that each successful registration request (using the basic username/password provider) will return an authorization token, and user_id that identifies the particular user in subsequent API requests.

Step 2: Upload a file as alice

Use the filestore API to upload

Use the data API to store metadata and filesharing info

Track the file uploaded by alice and the fact that she has shared it with bob

---

---

Make a file download API request as bob

Make a file download API request as anonymous or another user

---

How these APIs work

Apart from the Hasura auth APIs and the data APIs, the key in making the file sharing permissions work is the webhook that allow secure sharing.

By default the Hasura filestore APIs allow private only, or public permissions. To customise these settings, a permission webhook is used.

When a file download API request is made, the filestore APIs call the hook and determine if the file download should be allowed.

Here is the code in server.js:

app.get('/check_req', function( req, res ) {
  if ( req.query.file_op === 'read' ) {
    const file_id = req.query.file_id;
    const user_id = req.headers['x-hasura-user-id'];

    // Use the data APIs to check if the user requesting the file is one of the shared_users for this file
    const queryObj = {
      type: 'select',
      args: {
        table: 'user_file',
        columns: ['id'],
        where: { 'file_id': file_id,
          '$or': [
            {'user_id': parseInt(user_id, 10)},
            {'shared_users': { 'shared_user_id': parseInt(user_id, 10)}}
          ]
        }
      }
    };

    // Make this API call to the database and get the resultant 'rows'
    //...
    
    // Check the response and allow or disallow
    if ( rows.length > 0 ) {
        res.status(200).send('ok');
        return;
      }
      res.status(403).send('notok');
      return;

Now that we have this webhook deployed in a microservice called file-check, we configure the filestore API to use this webhook in conf/filestore.yaml:

hookUrl: http://file-check.default/check_req

The schema required for this application