ioctl-api

i/o/ctl

An E2E Encrypted Pastebin App

Try out here: https://bin.dronk.dev

Or, if you prefer, use the API directly: https://api.bin.dronk.dev

> echo "Hello, World!" > hello-world.txt 

> # just use curl --upload-file

> curl --upload-file hello-world.txt https://api.bin.dronk.dev

{"URL":"https://api.bin.dronk.dev/r/EmbossChemicals"}

> curl https://api.bin.dronk.dev/r/EmbossChemicals
Hello, World!

> echo "i/o/ctl is awesome!"
i/o/ctl is awesome!

Features:

• Store and fetch encrypted and end-to-end encrypted snippets
• Snippets get saved against an easy to remember, id like HedgingSmitten
• Snippets are compressed using zlib
• Use S3 as storage backend along with global CDN
• Send snippet as formatted JSON, E2E Encrypted JSON or raw body
• Use POST and PUT at endpoint / to save snippet
• Use POST and PUT at endpoint /e2e to end-to-end encypted snippet
• Get snippet using GET at endpoint /<ID> or /r/<ID> or directly from S3 / CDN
• Snippets are by default ephemeral and stored for 7 days

Quick Start:

Prerequisites: AWS S3, Docker, Docker Compose and curl

• git clone --depth=1 https://github.com/sid-sun/ioctl-api
• cd snippets-api
• edit quickstart.env and add your AWS S3 details (currently tied to AWS)
• docker compose up -d
• Upload a snippet
  • curl --upload-file dev.env http://localhost:8080/
  • Copy the URL field returned in JSON
• Fetch snippet
  • curl <URL you copied>
• docker compose down

Setup for Development:

• git clone --depth=1 https://github.com/sid-sun/ioctl-api
• cd snippets-api
• go mod download
• edit dev.env and add your AWS S3 details (currently tied to AWS)
• Start application server
  • env $(cat dev.env | xargs -L 1) go run src/main.go

Deployment / Self-Hosting:

The easiest way to self-host is to simply run an instance of realsidsun/snippets-api on a server, and reverse-proxy it after creating a S3 Bucket on AWS and a programatic access key and secret with the following permissions:

"Action": [
    "s3:PutObject",
    "s3:GetObject",
    "s3:GetObjectAttributes",
    "s3:ListBucket",
    "s3:PutObjectAcl"
]

NOTE: Look at the Config section down below before you deploy

Cryptographic Specification

• The Cryptographic specification is defined here

Config

Configuration is done through environment variables

General Config:

Example Overrides: About:BackwashLicorice,PrivacyPolicy:TranceUnsterile

Cryptographic Config:

S3 Config:

You only need one of these (as per your S3 Provider):

AWS S3 Config:

CloudFlare R2 Config:

HTTP Server Config: