https://github.com/hschne/data-dead-drop

Simple, quick data sharing. For humans and machines 🤖
https://github.com/hschne/data-dead-drop

hotwire rails security

Last synced: about 1 month ago
JSON representation

Simple, quick data sharing. For humans and machines 🤖

• Host: GitHub
• URL: https://github.com/hschne/data-dead-drop
• Owner: hschne
• Created: 2023-12-11T13:04:30.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-15T18:51:10.000Z (4 months ago)
• Last Synced: 2024-12-10T14:49:35.190Z (about 2 months ago)
• Topics: hotwire, rails, security
• Language: Ruby
• Homepage: https://datadeaddrop.com
• Size: 1.5 MB
• Stars: 40
• Watchers: 1
• Forks: 7
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


# Data Dead Drop



### Simple, secure file sharing. Data self-destroys after access.

[![Main](https://github.com/hschne/data-dead-drop/actions/workflows/main.yml/badge.svg)](https://github.com/hschne/data-dead-drop/actions/workflows/main.yml)

[![License](https://img.shields.io/github/license/hschne/data-dead-drop)](https://img.shields.io/github/license/hschne/data-dead-drop)



## Usage

Visit https://datadeaddrop.com to upload files, or upload files via the command line. For example using cURL:

```bash

curl https://datadeaddrop.com/upload \

  -X POST -H "Accept: application/json" \

  -F "upload[file][email protected]" -F "upload[expiry]=10" -F "upload[uses]=3"

```

Uploaded data will automatically be deleted after the specified number of minutes or uses. The maximum expiry is 60 minutes, and the maximum number of uses is 5. File size is limited to 1MB.

Data Dead drop will return a unique link generated using the [Diceware algorithm](https://en.wikipedia.org/wiki/Diceware) method. Use this link to download the file in the browser or via the command line.

```bash

curl https://datadeaddrop.com/download/your-secret-key \

  -L -H "Accept: application/json" > "your-file.text"

```

### API Documentation

Data Dead Drop's API is simple. If you want to build your own client use the `/upload` and `/download` endpoints.

#### Upload

```javascript

// POST /upload

{

  "file":"file.txt",

  "expiry":10,

  "uses":1

}

```

A successful request will return status code `200` and the following payload: 

```javascript

{

  "name":"file.txt"

  "key":"your-secret-key",

  "url":"http://datadeaddrop/d/your-secret-key",

  "expiry":"2024-12-24T18:10:00.000Z",

  "uses":3,

  "created_at":"2023-12-24T18:00:00.000Z",

}

```

#### Download

```javasript

# GET /download/your-secret-key

```

## Development

This is a Ruby on Rails application. To get started, clone the repo, install dependencies and prepare the database. You'll also need to seed the database with a Diceware word list.

```bash

bundle install

rails db:setup

rake import:dice_words

```

The start the server with 

```bash

rails server

```

### Testing

Data Dead Drop uses RSpec for testing. Run the test suite with

```bash

bundle exec rspec

```

### Deployment

Data Dead Drop is automatically deployed via GitHub actions using [Kamal](https://kamal-deploy.org/). To manually deploy you'll need SSH access to the server and access to the Docker Hub registry.

```bash

kamal setup

kamal deploy

```